Sophie

Sophie

distrib > Mandriva > 9.1 > i586 > by-pkgid > fe5519c3cf01ae1a657fa9aec5f121fc > files > 54

libSDLmm0.1-devel-0.1.8-5mdk.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>SDLmm::SPoint class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.2.8.1 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; <a class="qindex" href="pages.html">Related Pages</a> &nbsp; </center>
<hr><h1>SDLmm::SPoint  Class Reference</h1>A small usefull class representing a point in 2 dimensional space. 
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="sdlmm__spoint_8h-source.html">sdlmm_spoint.h</a>&gt;</code>
<p>
<a href="classSDLmm_1_1SPoint-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1SPoint.html#a0">SPoint</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Default constructor which creates an empty <a class="el" href="classSDLmm_1_1SPoint.html">SPoint</a> (xy variables set to zero).</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1SPoint.html#a1">SPoint</a> (const SPoint &amp;point)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>This is the copy constructor. Simply initializes the value of an <a class="el" href="classSDLmm_1_1SPoint.html">SPoint</a> to that of another <a class="el" href="classSDLmm_1_1SPoint.html">SPoint</a>.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1SPoint.html#a2">SPoint</a> (Sint16 nx, Sint16 ny)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Constructor which initializes the class from integer values.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>SPoint&amp;&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1SPoint.html#a3">operator=</a> (const SPoint &amp;point)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Set the value of an <a class="el" href="classSDLmm_1_1SPoint.html">SPoint</a> to that of an existing <a class="el" href="classSDLmm_1_1SPoint.html">SPoint</a>.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1SPoint.html#a4">operator==</a> (const SPoint &amp;point) const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Compare two points for equality.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1SPoint.html#a5">operator&lt;</a> (const SPoint &amp;point) const</td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1SPoint.html#a6">operator&lt;=</a> (const SPoint &amp;point) const</td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1SPoint.html#a7">operator&gt;</a> (const SPoint &amp;point) const</td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1SPoint.html#a8">operator&gt;=</a> (const SPoint &amp;point) const</td></tr>
<tr><td nowrap align=right valign=top>SPoint&amp;&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1SPoint.html#a9">operator+=</a> (const SPoint &amp;point)</td></tr>
<tr><td nowrap align=right valign=top>SPoint&amp;&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1SPoint.html#a10">operator-=</a> (const SPoint &amp;point)</td></tr>
<tr><td nowrap align=right valign=top>SPoint&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1SPoint.html#a11">operator+</a> (const SPoint &amp;point) const</td></tr>
<tr><td nowrap align=right valign=top>SPoint&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1SPoint.html#a12">operator-</a> (const SPoint &amp;point) const</td></tr>
<tr><td nowrap align=right valign=top>SPoint&amp;&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1SPoint.html#a13">operator *=</a> (Sint16 scalar)</td></tr>
<tr><td nowrap align=right valign=top>SPoint&amp;&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1SPoint.html#a14">operator/=</a> (Sint16 scalar)</td></tr>
<tr><td nowrap align=right valign=top>SPoint&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1SPoint.html#a15">operator *</a> (Sint16 scalar) const</td></tr>
<tr><td nowrap align=right valign=top>SPoint&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1SPoint.html#a16">operator/</a> (Sint16 scalar) const</td></tr>
<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top>Sint16&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1SPoint.html#m0">x</a></td></tr>
<tr><td nowrap align=right valign=top>Sint16&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1SPoint.html#m1">y</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A small usefull class representing a point in 2 dimensional space.
<p>
<dl compact><dt>
<b>Author: </b><dd>
Adam Gates </dl>
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="SDLmm::SPoint::SPoint"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
SDLmm::SPoint::SPoint (
          </b></td>
          <td valign="bottom"><b>
)<code> [inline]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Default constructor which creates an empty <a class="el" href="classSDLmm_1_1SPoint.html">SPoint</a> (xy variables set to zero).
<p>
    </td>
  </tr>
</table>
<a name="a1" doxytag="SDLmm::SPoint::SPoint"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
SDLmm::SPoint::SPoint (
          </b></td>
          <td valign="bottom"><b>
const SPoint &amp; <em>point</em>&nbsp;)<code> [inline]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
This is the copy constructor. Simply initializes the value of an <a class="el" href="classSDLmm_1_1SPoint.html">SPoint</a> to that of another <a class="el" href="classSDLmm_1_1SPoint.html">SPoint</a>.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>point</em>
&nbsp;</td><td>
an existing <a class="el" href="classSDLmm_1_1SPoint.html">SPoint</a> object. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="a2" doxytag="SDLmm::SPoint::SPoint"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
SDLmm::SPoint::SPoint (
          </b></td>
          <td valign="bottom"><b>
Sint16 <em>nx</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
Sint16 <em>ny</em>&nbsp;)<code> [inline]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Constructor which initializes the class from integer values.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>nx, horizontal</em>
&nbsp;</td><td>
position </td></tr>
<tr><td valign=top><em>ny, vertical</em>
&nbsp;</td><td>
position </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a15" doxytag="SDLmm::SPoint::operator *"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
SPoint SDLmm::SPoint::operator * (
          </b></td>
          <td valign="bottom"><b>
Sint16 <em>scalar</em>&nbsp;) const<code> [inline]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<a name="a13" doxytag="SDLmm::SPoint::operator *="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
SPoint &amp; SDLmm::SPoint::operator *= (
          </b></td>
          <td valign="bottom"><b>
Sint16 <em>scalar</em>&nbsp;)<code> [inline]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<a name="a11" doxytag="SDLmm::SPoint::operator+"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
SPoint SDLmm::SPoint::operator+ (
          </b></td>
          <td valign="bottom"><b>
const SPoint &amp; <em>point</em>&nbsp;) const<code> [inline]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<a name="a9" doxytag="SDLmm::SPoint::operator+="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
SPoint &amp; SDLmm::SPoint::operator+= (
          </b></td>
          <td valign="bottom"><b>
const SPoint &amp; <em>point</em>&nbsp;)<code> [inline]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<a name="a12" doxytag="SDLmm::SPoint::operator-"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
SPoint SDLmm::SPoint::operator- (
          </b></td>
          <td valign="bottom"><b>
const SPoint &amp; <em>point</em>&nbsp;) const<code> [inline]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<a name="a10" doxytag="SDLmm::SPoint::operator-="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
SPoint &amp; SDLmm::SPoint::operator-= (
          </b></td>
          <td valign="bottom"><b>
const SPoint &amp; <em>point</em>&nbsp;)<code> [inline]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<a name="a16" doxytag="SDLmm::SPoint::operator/"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
SPoint SDLmm::SPoint::operator/ (
          </b></td>
          <td valign="bottom"><b>
Sint16 <em>scalar</em>&nbsp;) const<code> [inline]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<a name="a14" doxytag="SDLmm::SPoint::operator/="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
SPoint &amp; SDLmm::SPoint::operator/= (
          </b></td>
          <td valign="bottom"><b>
Sint16 <em>scalar</em>&nbsp;)<code> [inline]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<a name="a5" doxytag="SDLmm::SPoint::operator<"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
bool SDLmm::SPoint::operator&lt; (
          </b></td>
          <td valign="bottom"><b>
const SPoint &amp; <em>point</em>&nbsp;) const<code> [inline]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<dl compact><dt>
<b>Returns: </b><dd>
true if both point.x and point.y is larger than x and y in this point. </dl>    </td>
  </tr>
</table>
<a name="a6" doxytag="SDLmm::SPoint::operator<="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
bool SDLmm::SPoint::operator&lt;= (
          </b></td>
          <td valign="bottom"><b>
const SPoint &amp; <em>point</em>&nbsp;) const<code> [inline]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<dl compact><dt>
<b>Returns: </b><dd>
true if both point.x and point.y is larger than or equal to x and y in this point. </dl>    </td>
  </tr>
</table>
<a name="a3" doxytag="SDLmm::SPoint::operator="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
SPoint &amp; SDLmm::SPoint::operator= (
          </b></td>
          <td valign="bottom"><b>
const SPoint &amp; <em>point</em>&nbsp;)<code> [inline]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Set the value of an <a class="el" href="classSDLmm_1_1SPoint.html">SPoint</a> to that of an existing <a class="el" href="classSDLmm_1_1SPoint.html">SPoint</a>.
<p>
    </td>
  </tr>
</table>
<a name="a4" doxytag="SDLmm::SPoint::operator=="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
bool SDLmm::SPoint::operator== (
          </b></td>
          <td valign="bottom"><b>
const SPoint &amp; <em>point</em>&nbsp;) const<code> [inline]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Compare two points for equality.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
true if coordinates are identical in both points. </dl>    </td>
  </tr>
</table>
<a name="a7" doxytag="SDLmm::SPoint::operator>"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
bool SDLmm::SPoint::operator&gt; (
          </b></td>
          <td valign="bottom"><b>
const SPoint &amp; <em>point</em>&nbsp;) const<code> [inline]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<dl compact><dt>
<b>Returns: </b><dd>
true if both point.x and point.y is smaller than x and y in this point. </dl>    </td>
  </tr>
</table>
<a name="a8" doxytag="SDLmm::SPoint::operator>="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
bool SDLmm::SPoint::operator&gt;= (
          </b></td>
          <td valign="bottom"><b>
const SPoint &amp; <em>point</em>&nbsp;) const<code> [inline]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<dl compact><dt>
<b>Returns: </b><dd>
true if both point.x and point.y is smaller than or equal to x and y in this point. </dl>    </td>
  </tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="m0" doxytag="SDLmm::SPoint::x"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
Sint16 SDLmm::SPoint::x
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<a name="m1" doxytag="SDLmm::SPoint::y"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
Sint16 SDLmm::SPoint::y
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="sdlmm__spoint_8h-source.html">sdlmm_spoint.h</a></ul>
<hr>
<table cellspacing=10 cellpadding=0 border=0 width=100%>
<tr valign=middle><td><font size=-1>Documentation automatically generated by <a
href="http://www.stack.nl/~dimitri/doxygen/"><img border=0 align=center src="doxygen.gif" alt="doxygen"></a> written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>.</font></td>
<td align=right><font size=-1>Project hosted at <br><a href="http://sourceforge.net"><img align=middle src="http://sourceforge.net/sflogo.php?group_id=25445&type=1" width="88" height="31" border="0"  alt="Hosted by SourceForge"></a></font></td></tr></table>