blob: ddf259c26ffd4fba479f068d672b0840cb12b48a [file] [log] [blame]
{{+bindTo:partials.standard_nacl_api}}
<h1>point.h File Reference</h1>
<div id="doxygen-ref">
{{- dummy div to appease doxygen -}}
<div>
<!-- Generated by Doxygen 1.7.6.1 -->
</div>
<!--header-->
<div class="contents">
<div class="textblock"><div class="dynheader">
Include dependency graph for point.h:</div>
<div class="dyncontent">
<div class="center"><img src="point_8h__incl.png" border="0" usemap="#point_8h" alt="" /></div>
<map name="point_8h" id="point_8h">
</map>
</div>
</div><h2>
Classes</h2><table class="memberdecls">
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_point.html">pp::Point</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">A 2 dimensional point with 0,0 being the upper-left starting coordinate. <a href="classpp_1_1_point.html#details">More...</a><br /></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_point.html">pp::FloatPoint</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">A 2 dimensional floating-point point with 0,0 being the upper-left starting coordinate. <a href="classpp_1_1_float_point.html#details">More...</a><br /></td></tr>
</table><h2>
Namespaces</h2><table class="memberdecls">
<tr><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepp.html">pp</a></td></tr>
</table><h2>
Functions</h2><table class="memberdecls">
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="point_8h.html#acdca90fb96f299839dcea8d836d6f92f">operator==</a> (const <a class="el" href="classpp_1_1_point.html">pp::Point</a> &amp;lhs, const <a class="el" href="classpp_1_1_point.html">pp::Point</a> &amp;rhs)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="point_8h.html#a49089c373eeebff274a723f7545b7680">operator!=</a> (const <a class="el" href="classpp_1_1_point.html">pp::Point</a> &amp;lhs, const <a class="el" href="classpp_1_1_point.html">pp::Point</a> &amp;rhs)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="point_8h.html#a59d82ac98ce35697fae48edd66a7fdba">operator==</a> (const <a class="el" href="classpp_1_1_float_point.html">pp::FloatPoint</a> &amp;lhs, const <a class="el" href="classpp_1_1_float_point.html">pp::FloatPoint</a> &amp;rhs)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="point_8h.html#a429594ae059c2956f538876c3c4e68c2">operator!=</a> (const <a class="el" href="classpp_1_1_float_point.html">pp::FloatPoint</a> &amp;lhs, const <a class="el" href="classpp_1_1_float_point.html">pp::FloatPoint</a> &amp;rhs)</td></tr>
</table>
<hr /><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This file defines the API to create a 2 dimensional point. </p>
</div><hr /><h2>Function Documentation</h2>
<a class="anchor" id="a49089c373eeebff274a723f7545b7680"></a><!-- doxytag: member="point.h::operator!=" ref="a49089c373eeebff274a723f7545b7680" args="(const pp::Point &amp;lhs, const pp::Point &amp;rhs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_point.html">pp::Point</a> &amp;&#160;</td>
<td class="paramname"><em>lhs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classpp_1_1_point.html">pp::Point</a> &amp;&#160;</td>
<td class="paramname"><em>rhs</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Determines whether two Points have different coordinates. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">lhs</td><td>The Point on the left-hand side of the equation. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">rhs</td><td>The Point on the right-hand side of the equation.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the coordinates of lhs are equal to the coordinates of rhs, otherwise false. </dd></dl>
</div>
</div>
<a class="anchor" id="a429594ae059c2956f538876c3c4e68c2"></a><!-- doxytag: member="point.h::operator!=" ref="a429594ae059c2956f538876c3c4e68c2" args="(const pp::FloatPoint &amp;lhs, const pp::FloatPoint &amp;rhs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_float_point.html">pp::FloatPoint</a> &amp;&#160;</td>
<td class="paramname"><em>lhs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classpp_1_1_float_point.html">pp::FloatPoint</a> &amp;&#160;</td>
<td class="paramname"><em>rhs</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Determines whether two Points have different coordinates. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">lhs</td><td>The Point on the left-hand side of the equation. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">rhs</td><td>The Point on the right-hand side of the equation.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the coordinates of lhs are equal to the coordinates of rhs, otherwise false. </dd></dl>
</div>
</div>
<a class="anchor" id="acdca90fb96f299839dcea8d836d6f92f"></a><!-- doxytag: member="point.h::operator==" ref="acdca90fb96f299839dcea8d836d6f92f" args="(const pp::Point &amp;lhs, const pp::Point &amp;rhs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_point.html">pp::Point</a> &amp;&#160;</td>
<td class="paramname"><em>lhs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classpp_1_1_point.html">pp::Point</a> &amp;&#160;</td>
<td class="paramname"><em>rhs</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Determines whether the x and y values of two Points are equal. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">lhs</td><td>The Point on the left-hand side of the equation. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">rhs</td><td>The Point on the right-hand side of the equation.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if they are equal, false if unequal. </dd></dl>
</div>
</div>
<a class="anchor" id="a59d82ac98ce35697fae48edd66a7fdba"></a><!-- doxytag: member="point.h::operator==" ref="a59d82ac98ce35697fae48edd66a7fdba" args="(const pp::FloatPoint &amp;lhs, const pp::FloatPoint &amp;rhs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_float_point.html">pp::FloatPoint</a> &amp;&#160;</td>
<td class="paramname"><em>lhs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classpp_1_1_float_point.html">pp::FloatPoint</a> &amp;&#160;</td>
<td class="paramname"><em>rhs</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Determines whether the x and y values of two FloatPoints are equal. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">lhs</td><td>The Point on the left-hand side of the equation. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">rhs</td><td>The Point on the right-hand side of the equation.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if they are equal, false if unequal. </dd></dl>
</div>
</div>
</div><!-- contents -->
</div>
{{/partials.standard_nacl_api}}