Sophie

Sophie

distrib > Fedora > 14 > x86_64 > by-pkgid > d9e51bfaa0475c88e86a4c5026a65fa0 > files > 84

qwtpolar-devel-0.1.0-5.fc14.i686.rpm

<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Qwt Polar User&#39;s Guide: QwtPolarPoint Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Qwt Polar User's Guide&#160;<span id="projectnumber">0.1.0</span></div>
  </td>
 </tr>
 </tbody>
</table>
</div>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</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>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">QwtPolarPoint Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="QwtPolarPoint" -->
<p>A point in polar coordinates.  
 <a href="class_qwt_polar_point.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="qwt__polar__point_8h_source.html">qwt_polar_point.h</a>&gt;</code></p>

<p><a href="class_qwt_polar_point-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_polar_point.html#ae365733bb3b35ea129d1421004ec6b08">QwtPolarPoint</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_polar_point.html#a92ce1bbe1383b3485b22eef3901009a5">QwtPolarPoint</a> (double azimuth, double radius)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_polar_point.html#ada72937ec2ad82e07dba302273527bf5">QwtPolarPoint</a> (const <a class="el" href="class_qwt_polar_point.html">QwtPolarPoint</a> &amp;)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_polar_point.html#aeb88ac1f81b9f20f0cf37458629d89a5">QwtPolarPoint</a> (const QwtDoublePoint &amp;)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_polar_point.html#a80ed9b13956587d458fe08ee55e9973b">setPoint</a> (const QwtDoublePoint &amp;)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QwtDoublePoint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_polar_point.html#ab383e31ac1d5ee927369664c0049ab2b">toPoint</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_polar_point.html#ac0423d78674ed4a7ad22f0d1f0a22cfb">isValid</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_polar_point.html#ac6c9821d230768aaf886eaadd4b5985b">isNull</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_polar_point.html#a205eede4fd4540d67864189d3f22c11c">radius</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_polar_point.html#a946032168eb8ee23d120c63db009e399">azimuth</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_polar_point.html#ae85a02f72e713f4bb2ecd2977145ee2b">rRadius</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_polar_point.html#a19a0ebbc71e1afed7f393ab96529ba91">rAzimuth</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_polar_point.html#aec37df23799f604ba2bb9df33e7c856c">setRadius</a> (double)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_polar_point.html#ad3630ff58dec8c5953b2db08d6d339ab">setAzimuth</a> (double)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_polar_point.html#a30348d0476a9e7a9f1f09e2fdb08fdce">operator==</a> (const <a class="el" href="class_qwt_polar_point.html">QwtPolarPoint</a> &amp;) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_polar_point.html#a1bea7f2872403e179d6ec4d127d2c2bf">operator!=</a> (const <a class="el" href="class_qwt_polar_point.html">QwtPolarPoint</a> &amp;) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_qwt_polar_point.html">QwtPolarPoint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_polar_point.html#a80ca9c137602f478f78580f717c4b37c">normalized</a> () const </td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A point in polar coordinates. </p>
<p>In polar coordinates a point is determined by an angle and a distance. See <a href="http://en.wikipedia.org/wiki/Polar_coordinate_system">http://en.wikipedia.org/wiki/Polar_coordinate_system</a> </p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ae365733bb3b35ea129d1421004ec6b08"></a><!-- doxytag: member="QwtPolarPoint::QwtPolarPoint" ref="ae365733bb3b35ea129d1421004ec6b08" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QwtPolarPoint::QwtPolarPoint </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Constructs a null point, with a radius and azimuth set to 0.0. </p>
<dl class="see"><dt><b>See also:</b></dt><dd>QwtDoublePoint::isNull </dd></dl>

</div>
</div>
<a class="anchor" id="a92ce1bbe1383b3485b22eef3901009a5"></a><!-- doxytag: member="QwtPolarPoint::QwtPolarPoint" ref="a92ce1bbe1383b3485b22eef3901009a5" args="(double azimuth, double radius)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QwtPolarPoint::QwtPolarPoint </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>azimuth</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>radius</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Constructs a point with coordinates specified by radius and azimuth.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">azimuth</td><td>Azimuth </td></tr>
    <tr><td class="paramname">radius</td><td>Radius </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ada72937ec2ad82e07dba302273527bf5"></a><!-- doxytag: member="QwtPolarPoint::QwtPolarPoint" ref="ada72937ec2ad82e07dba302273527bf5" args="(const QwtPolarPoint &amp;)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QwtPolarPoint::QwtPolarPoint </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_qwt_polar_point.html">QwtPolarPoint</a> &amp;&#160;</td>
          <td class="paramname"><em>other</em></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Constructs a point using the values of the point specified. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">other</td><td>Other point </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="aeb88ac1f81b9f20f0cf37458629d89a5"></a><!-- doxytag: member="QwtPolarPoint::QwtPolarPoint" ref="aeb88ac1f81b9f20f0cf37458629d89a5" args="(const QwtDoublePoint &amp;)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QwtPolarPoint::QwtPolarPoint </td>
          <td>(</td>
          <td class="paramtype">const QwtDoublePoint &amp;&#160;</td>
          <td class="paramname"><em>p</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Convert and assign values from a point in Cartesian coordinates</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">p</td><td>Point in Cartesian coordinates </td></tr>
  </table>
  </dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_qwt_polar_point.html#a80ed9b13956587d458fe08ee55e9973b">setPoint()</a>, <a class="el" href="class_qwt_polar_point.html#ab383e31ac1d5ee927369664c0049ab2b">toPoint()</a> </dd></dl>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a946032168eb8ee23d120c63db009e399"></a><!-- doxytag: member="QwtPolarPoint::azimuth" ref="a946032168eb8ee23d120c63db009e399" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double QwtPolarPoint::azimuth </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the azimuth. </p>

</div>
</div>
<a class="anchor" id="ac6c9821d230768aaf886eaadd4b5985b"></a><!-- doxytag: member="QwtPolarPoint::isNull" ref="ac6c9821d230768aaf886eaadd4b5985b" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool QwtPolarPoint::isNull </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns true if <a class="el" href="class_qwt_polar_point.html#a205eede4fd4540d67864189d3f22c11c" title="Returns the radius.">radius()</a> &gt;= 0.0. </p>

</div>
</div>
<a class="anchor" id="ac0423d78674ed4a7ad22f0d1f0a22cfb"></a><!-- doxytag: member="QwtPolarPoint::isValid" ref="ac0423d78674ed4a7ad22f0d1f0a22cfb" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool QwtPolarPoint::isValid </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns true if <a class="el" href="class_qwt_polar_point.html#a205eede4fd4540d67864189d3f22c11c" title="Returns the radius.">radius()</a> &gt;= 0.0. </p>

</div>
</div>
<a class="anchor" id="a80ca9c137602f478f78580f717c4b37c"></a><!-- doxytag: member="QwtPolarPoint::normalized" ref="a80ca9c137602f478f78580f717c4b37c" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_qwt_polar_point.html">QwtPolarPoint</a> QwtPolarPoint::normalized </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Normalize radius and azimuth</p>
<p>When the radius is &lt; 0.0 it is set to 0.0. The azimuth is a value &gt;= 0.0 and &lt; 2 * M_PI. </p>

</div>
</div>
<a class="anchor" id="a1bea7f2872403e179d6ec4d127d2c2bf"></a><!-- doxytag: member="QwtPolarPoint::operator!=" ref="a1bea7f2872403e179d6ec4d127d2c2bf" args="(const QwtPolarPoint &amp;) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool QwtPolarPoint::operator!= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_qwt_polar_point.html">QwtPolarPoint</a> &amp;&#160;</td>
          <td class="paramname"><em>other</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns true if point1 is not equal to point2; otherwise returns false.</p>
<p>Two points are equal to each other if radius and azimuth-coordinates are the same. Points are not equal, when the azimuth differs, but other.azimuth() == <a class="el" href="class_qwt_polar_point.html#a946032168eb8ee23d120c63db009e399" title="Returns the azimuth.">azimuth()</a> % (2 * PI).</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_qwt_polar_point.html#a80ca9c137602f478f78580f717c4b37c">normalized()</a> </dd></dl>

</div>
</div>
<a class="anchor" id="a30348d0476a9e7a9f1f09e2fdb08fdce"></a><!-- doxytag: member="QwtPolarPoint::operator==" ref="a30348d0476a9e7a9f1f09e2fdb08fdce" args="(const QwtPolarPoint &amp;) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool QwtPolarPoint::operator== </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_qwt_polar_point.html">QwtPolarPoint</a> &amp;&#160;</td>
          <td class="paramname"><em>other</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns true if point1 is equal to point2; otherwise returns false.</p>
<p>Two points are equal to each other if radius and azimuth-coordinates are the same. Points are not equal, when the azimuth differs, but other.azimuth() == <a class="el" href="class_qwt_polar_point.html#a946032168eb8ee23d120c63db009e399" title="Returns the azimuth.">azimuth()</a> % (2 * PI).</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_qwt_polar_point.html#a80ca9c137602f478f78580f717c4b37c">normalized()</a> </dd></dl>

</div>
</div>
<a class="anchor" id="a205eede4fd4540d67864189d3f22c11c"></a><!-- doxytag: member="QwtPolarPoint::radius" ref="a205eede4fd4540d67864189d3f22c11c" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double QwtPolarPoint::radius </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the radius. </p>

</div>
</div>
<a class="anchor" id="a19a0ebbc71e1afed7f393ab96529ba91"></a><!-- doxytag: member="QwtPolarPoint::rAzimuth" ref="a19a0ebbc71e1afed7f393ab96529ba91" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double &amp; QwtPolarPoint::rAzimuth </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the azimuth. </p>

</div>
</div>
<a class="anchor" id="ae85a02f72e713f4bb2ecd2977145ee2b"></a><!-- doxytag: member="QwtPolarPoint::rRadius" ref="ae85a02f72e713f4bb2ecd2977145ee2b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double &amp; QwtPolarPoint::rRadius </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the radius. </p>

</div>
</div>
<a class="anchor" id="ad3630ff58dec8c5953b2db08d6d339ab"></a><!-- doxytag: member="QwtPolarPoint::setAzimuth" ref="ad3630ff58dec8c5953b2db08d6d339ab" args="(double)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void QwtPolarPoint::setAzimuth </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>azimuth</em></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Sets the atimuth to atimuth. </p>

</div>
</div>
<a class="anchor" id="a80ed9b13956587d458fe08ee55e9973b"></a><!-- doxytag: member="QwtPolarPoint::setPoint" ref="a80ed9b13956587d458fe08ee55e9973b" args="(const QwtDoublePoint &amp;)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void QwtPolarPoint::setPoint </td>
          <td>(</td>
          <td class="paramtype">const QwtDoublePoint &amp;&#160;</td>
          <td class="paramname"><em>p</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Convert and assign values from a point in Cartesian coordinates </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">p</td><td>Point in Cartesian coordinates </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="aec37df23799f604ba2bb9df33e7c856c"></a><!-- doxytag: member="QwtPolarPoint::setRadius" ref="aec37df23799f604ba2bb9df33e7c856c" args="(double)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void QwtPolarPoint::setRadius </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>radius</em></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Sets the radius to radius. </p>

</div>
</div>
<a class="anchor" id="ab383e31ac1d5ee927369664c0049ab2b"></a><!-- doxytag: member="QwtPolarPoint::toPoint" ref="ab383e31ac1d5ee927369664c0049ab2b" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QwtDoublePoint QwtPolarPoint::toPoint </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Convert and return values in Cartesian coordinates</p>
<dl class="note"><dt><b>Note:</b></dt><dd>Invalid or null points will be returned as QwtDoublePoint(0.0, 0.0) </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_qwt_polar_point.html#ac0423d78674ed4a7ad22f0d1f0a22cfb" title="Returns true if radius() &gt;= 0.0.">isValid()</a>, <a class="el" href="class_qwt_polar_point.html#ac6c9821d230768aaf886eaadd4b5985b" title="Returns true if radius() &gt;= 0.0.">isNull()</a> </dd></dl>

</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jul 17 2011 for Qwt Polar User's Guide by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>