blob: 43b25a59239516fbe866b8582be8621498603ef4 [file] [log] [blame]
{{+bindTo:partials.standard_nacl_api}}
<h1>pp::FloatRect Class Reference</h1>
<div id="doxygen-ref">
{{- dummy div to appease doxygen -}}
<div>
<!-- Generated by Doxygen 1.7.6.1 -->
</div>
<!--header-->
<div class="contents">
<!-- doxytag: class="pp::FloatRect" -->
<p><a href="classpp_1_1_float_rect-members.html">List of all members.</a></p>
<h2>
Public Member Functions</h2><table class="memberdecls">
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#a00133448de297c5ed19b7831c456bf23">FloatRect</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#aaf4f5bb63c29eb79aa336bf0444d19ac">FloatRect</a> (const PP_FloatRect &amp;rect)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#a8216cb8951805b04a00909b860a949dc">FloatRect</a> (float w, float h)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#a02d2648692b0882ff54d812da3704aeb">FloatRect</a> (float <a class="el" href="classpp_1_1_float_rect.html#a4820c673dc07e6b35f8fc0c42368e92c">x</a>, float <a class="el" href="classpp_1_1_float_rect.html#ae31847965339e36aa1fe6c4cf8cf479c">y</a>, float w, float h)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#a7072595c890bc203544e55cd926d72ae">FloatRect</a> (const <a class="el" href="classpp_1_1_float_size.html">FloatSize</a> &amp;s)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#a643d926ee6f5e9208fccffd47c1d22be">FloatRect</a> (const <a class="el" href="classpp_1_1_float_point.html">FloatPoint</a> &amp;origin, const <a class="el" href="classpp_1_1_float_size.html">FloatSize</a> &amp;size)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#aa64361055526791e34cba09d97d2cf75">~FloatRect</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#a85c34bdfd11703d4cc86486b3f38a032">operator PP_FloatRect</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const PP_FloatRect &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#aa63a6eab8caae819c7efb133b89e3ec2">pp_float_rect</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">PP_FloatRect &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#a796ff93f77b488ac673b0e82a2527507">pp_float_rect</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#a4820c673dc07e6b35f8fc0c42368e92c">x</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#a52ed4022d98fc75e2bfd942ba0fb982f">set_x</a> (float in_x)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#ae31847965339e36aa1fe6c4cf8cf479c">y</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#a3b3a43a2764b7c0b6e6fad7bed300164">set_y</a> (float in_y)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#a25ffcc41df9f488acf15613f20e240db">width</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#a9553c5bf8b2c00bc9eeb7a7c2c22d0f7">set_width</a> (float w)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#a9dc3d3004aacf708356a73e09d1cc96e">height</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#a81a0cc8fc8521167b34b10e75f94679f">set_height</a> (float h)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_float_point.html">FloatPoint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#ae3f310aaeb5634e9f2ca7d51e35526a5">point</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#a80c403de88c32d76c0a774e2af5c4973">set_point</a> (const <a class="el" href="classpp_1_1_float_point.html">FloatPoint</a> &amp;origin)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_float_size.html">FloatSize</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#aee27f20031234762c710d441bc0cd148">Floatsize</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#a132796b0ca75d600509731d8c5a83736">set_size</a> (const <a class="el" href="classpp_1_1_float_size.html">FloatSize</a> &amp;s)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#a34632c0a01c72fce447ac6b6f0cdf86b">right</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#ae356a34c997e6c291fdc0e3431a0a63c">bottom</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#acfadd4bca5c16f05d138e4074b557df2">SetRect</a> (float <a class="el" href="classpp_1_1_float_rect.html#a4820c673dc07e6b35f8fc0c42368e92c">x</a>, float <a class="el" href="classpp_1_1_float_rect.html#ae31847965339e36aa1fe6c4cf8cf479c">y</a>, float w, float h)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#ae5c915a40cd7689798c7395824132117">SetRect</a> (const PP_FloatRect &amp;rect)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#a2d8abde94cff6a5813c2849dce42d707">Inset</a> (float horizontal, float vertical)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#a24f94c63d2f097bd7f8b45a2c375077c">Inset</a> (float left, float top, float <a class="el" href="classpp_1_1_float_rect.html#a34632c0a01c72fce447ac6b6f0cdf86b">right</a>, float <a class="el" href="classpp_1_1_float_rect.html#ae356a34c997e6c291fdc0e3431a0a63c">bottom</a>)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#a9b5247961b45da6dc5c656b906462f8b">Offset</a> (float horizontal, float vertical)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#a60fce18269499d5c9f8c2446319844c3">Offset</a> (const <a class="el" href="classpp_1_1_float_point.html">FloatPoint</a> &amp;<a class="el" href="classpp_1_1_float_rect.html#ae3f310aaeb5634e9f2ca7d51e35526a5">point</a>)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#a73c6f15d2c2ed26a2bd8893efeab1dcb">IsEmpty</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#a82bd21c4fc823d212a7526c2f03e3d43">Contains</a> (float point_x, float point_y) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#a82eaf22456cdf77d6a588ae86e4e86f9">Contains</a> (const <a class="el" href="classpp_1_1_float_point.html">FloatPoint</a> &amp;<a class="el" href="classpp_1_1_float_rect.html#ae3f310aaeb5634e9f2ca7d51e35526a5">point</a>) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#afcdf6b7eb8e1b931ac482c973af9fa9e">Contains</a> (const <a class="el" href="classpp_1_1_float_rect.html">FloatRect</a> &amp;rect) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#a701e3ca1e1cbd0ee10c432effb119088">Intersects</a> (const <a class="el" href="classpp_1_1_float_rect.html">FloatRect</a> &amp;rect) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_float_rect.html">FloatRect</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#a6529366c00323c6d6495f3db14906ce8">Intersect</a> (const <a class="el" href="classpp_1_1_float_rect.html">FloatRect</a> &amp;rect) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_float_rect.html">FloatRect</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#abb13835e0dbea82794cd4fa9140adb1e">Union</a> (const <a class="el" href="classpp_1_1_float_rect.html">FloatRect</a> &amp;rect) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_float_rect.html">FloatRect</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#a8b1c8031d1442dfcc0d11ea75b396683">Subtract</a> (const <a class="el" href="classpp_1_1_float_rect.html">FloatRect</a> &amp;rect) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_float_rect.html">FloatRect</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#af0009bd0ff6ac801359fb9d15a8c1b7c">AdjustToFit</a> (const <a class="el" href="classpp_1_1_float_rect.html">FloatRect</a> &amp;rect) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_float_point.html">FloatPoint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#a55eafb38d0a63a1a8b1ad0a4aeeef3f3">CenterPoint</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_rect.html#a9ab2652f39dc26de8c6750cc8d75d66a">SharesEdgeWith</a> (const <a class="el" href="classpp_1_1_float_rect.html">FloatRect</a> &amp;rect) const </td></tr>
</table>
<hr /><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A 2 dimensional rectangle. </p>
<p>A rectangle is represented by x and y (which identifies the upper-left corner of the rectangle), width, and height. </p>
</div><hr /><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a00133448de297c5ed19b7831c456bf23"></a><!-- doxytag: member="pp::FloatRect::FloatRect" ref="a00133448de297c5ed19b7831c456bf23" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_float_rect.html#a00133448de297c5ed19b7831c456bf23">pp::FloatRect::FloatRect</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The default constructor. </p>
<p>Creates a <code><a class="el" href="classpp_1_1_rect.html" title="A 2 dimensional rectangle.">Rect</a></code> in the upper-left at 0.0f,0.0f with height and width of 0.0f. </p>
</div>
</div>
<a class="anchor" id="aaf4f5bb63c29eb79aa336bf0444d19ac"></a><!-- doxytag: member="pp::FloatRect::FloatRect" ref="aaf4f5bb63c29eb79aa336bf0444d19ac" args="(const PP_FloatRect &amp;rect)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_float_rect.html#a00133448de297c5ed19b7831c456bf23">pp::FloatRect::FloatRect</a> </td>
<td>(</td>
<td class="paramtype">const PP_FloatRect &amp;&#160;</td>
<td class="paramname"><em>rect</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A constructor accepting a reference to a <code>PP_FloatRect and</code> converting the <code>PP_FloatRect</code> to a <code><a class="el" href="classpp_1_1_float_rect.html" title="A 2 dimensional rectangle.">FloatRect</a></code>. </p>
<p>This is an implicit conversion constructor.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">rect</td><td>A <code>PP_FloatRect</code>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a8216cb8951805b04a00909b860a949dc"></a><!-- doxytag: member="pp::FloatRect::FloatRect" ref="a8216cb8951805b04a00909b860a949dc" args="(float w, float h)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_float_rect.html#a00133448de297c5ed19b7831c456bf23">pp::FloatRect::FloatRect</a> </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>w</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>h</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A constructor accepting two float values for width and height and converting them to a <code><a class="el" href="classpp_1_1_float_rect.html" title="A 2 dimensional rectangle.">FloatRect</a></code> in the upper-left starting coordinate of 0.0f, 0.0f. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">w</td><td>An float value representing a width. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">h</td><td>An float value representing a height. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a02d2648692b0882ff54d812da3704aeb"></a><!-- doxytag: member="pp::FloatRect::FloatRect" ref="a02d2648692b0882ff54d812da3704aeb" args="(float x, float y, float w, float h)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_float_rect.html#a00133448de297c5ed19b7831c456bf23">pp::FloatRect::FloatRect</a> </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>w</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>h</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A constructor accepting four float values for width, height, x, and y. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>An float value representing a horizontal coordinate of a point, starting with 0.0f as the left-most coordinate. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>An float value representing a vertical coordinate of a point, starting with 0.0f as the top-most coordinate. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">w</td><td>An float value representing a width. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">h</td><td>An float value representing a height. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a7072595c890bc203544e55cd926d72ae"></a><!-- doxytag: member="pp::FloatRect::FloatRect" ref="a7072595c890bc203544e55cd926d72ae" args="(const FloatSize &amp;s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_float_rect.html#a00133448de297c5ed19b7831c456bf23">pp::FloatRect::FloatRect</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_float_size.html">FloatSize</a> &amp;&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td><code> [inline, explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A constructor accepting a pointer to a <a class="el" href="classpp_1_1_float_size.html" title="A size of an object based on width and height.">FloatSize</a> and converting the <code><a class="el" href="classpp_1_1_float_size.html" title="A size of an object based on width and height.">FloatSize</a></code> to a <code><a class="el" href="classpp_1_1_float_rect.html" title="A 2 dimensional rectangle.">FloatRect</a></code> in the upper-left starting coordinate of 0.0f,0.0f. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>A pointer to a <code><a class="el" href="classpp_1_1_float_size.html" title="A size of an object based on width and height.">FloatSize</a></code>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a643d926ee6f5e9208fccffd47c1d22be"></a><!-- doxytag: member="pp::FloatRect::FloatRect" ref="a643d926ee6f5e9208fccffd47c1d22be" args="(const FloatPoint &amp;origin, const FloatSize &amp;size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_float_rect.html#a00133448de297c5ed19b7831c456bf23">pp::FloatRect::FloatRect</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_float_point.html">FloatPoint</a> &amp;&#160;</td>
<td class="paramname"><em>origin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classpp_1_1_float_size.html">FloatSize</a> &amp;&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A constructor accepting a pointer to a <code><a class="el" href="classpp_1_1_float_point.html" title="A 2 dimensional floating-point point with 0,0 being the upper-left starting coordinate.">FloatPoint</a></code> representing the origin of the rectangle and a pointer to a <code><a class="el" href="classpp_1_1_float_size.html" title="A size of an object based on width and height.">FloatSize</a></code> representing the height and width. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">origin</td><td>A pointer to a <code><a class="el" href="classpp_1_1_float_point.html" title="A 2 dimensional floating-point point with 0,0 being the upper-left starting coordinate.">FloatPoint</a></code> representing the upper-left starting coordinate. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>A pointer to a <code><a class="el" href="classpp_1_1_float_size.html" title="A size of an object based on width and height.">FloatSize</a></code> representing the height and width. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa64361055526791e34cba09d97d2cf75"></a><!-- doxytag: member="pp::FloatRect::~FloatRect" ref="aa64361055526791e34cba09d97d2cf75" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_float_rect.html#aa64361055526791e34cba09d97d2cf75">pp::FloatRect::~FloatRect</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<hr /><h2>Member Function Documentation</h2>
<a class="anchor" id="af0009bd0ff6ac801359fb9d15a8c1b7c"></a><!-- doxytag: member="pp::FloatRect::AdjustToFit" ref="af0009bd0ff6ac801359fb9d15a8c1b7c" args="(const FloatRect &amp;rect) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_float_rect.html">FloatRect</a> <a class="el" href="classpp_1_1_float_rect.html#af0009bd0ff6ac801359fb9d15a8c1b7c">pp::FloatRect::AdjustToFit</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_float_rect.html">FloatRect</a> &amp;&#160;</td>
<td class="paramname"><em>rect</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classpp_1_1_float_rect.html#af0009bd0ff6ac801359fb9d15a8c1b7c" title="AdjustToFit() fits as much of the receiving rectangle within the supplied rectangle as possible...">AdjustToFit()</a> fits as much of the receiving rectangle within the supplied rectangle as possible, returning the result. </p>
<p>For example, if the receiver had a x-location of 2 and a width of 4, and the supplied rectangle had an x-location of 0 with a width of 5, the returned rectangle would have an x-location of 1 with a width of 4.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">rect</td><td>A pointer to a <code><a class="el" href="classpp_1_1_float_rect.html" title="A 2 dimensional rectangle.">FloatRect</a></code>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <code><a class="el" href="classpp_1_1_float_rect.html" title="A 2 dimensional rectangle.">FloatRect</a></code> representing the difference between this rectangle and the receiving rectangle. </dd></dl>
</div>
</div>
<a class="anchor" id="ae356a34c997e6c291fdc0e3431a0a63c"></a><!-- doxytag: member="pp::FloatRect::bottom" ref="ae356a34c997e6c291fdc0e3431a0a63c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float <a class="el" href="classpp_1_1_float_rect.html#ae356a34c997e6c291fdc0e3431a0a63c">pp::FloatRect::bottom</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Getter function to get the upper-bound for the y-coordinates of the rectangle. </p>
<p>Note that this coordinate value is one past the highest xy value of pixels in the rectangle. This loop will access all the pixels in a horizontal line in the rectangle: <code>for (float y = rect.y(); y &lt; rect.bottom(); ++y) {}</code></p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The value of y + height for this point. </dd></dl>
</div>
</div>
<a class="anchor" id="a55eafb38d0a63a1a8b1ad0a4aeeef3f3"></a><!-- doxytag: member="pp::FloatRect::CenterPoint" ref="a55eafb38d0a63a1a8b1ad0a4aeeef3f3" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_float_point.html">FloatPoint</a> <a class="el" href="classpp_1_1_float_rect.html#a55eafb38d0a63a1a8b1ad0a4aeeef3f3">pp::FloatRect::CenterPoint</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classpp_1_1_float_rect.html#a55eafb38d0a63a1a8b1ad0a4aeeef3f3" title="CenterPoint() determines the center of this rectangle.">CenterPoint()</a> determines the center of this rectangle. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <code><a class="el" href="classpp_1_1_float_point.html" title="A 2 dimensional floating-point point with 0,0 being the upper-left starting coordinate.">FloatPoint</a></code> representing the center of this rectangle. </dd></dl>
</div>
</div>
<a class="anchor" id="a82bd21c4fc823d212a7526c2f03e3d43"></a><!-- doxytag: member="pp::FloatRect::Contains" ref="a82bd21c4fc823d212a7526c2f03e3d43" args="(float point_x, float point_y) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classpp_1_1_float_rect.html#a82bd21c4fc823d212a7526c2f03e3d43">pp::FloatRect::Contains</a> </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>point_x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>point_y</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classpp_1_1_float_rect.html#a82bd21c4fc823d212a7526c2f03e3d43" title="Contains() determines if the point identified by point_x and point_y falls inside this rectangle...">Contains()</a> determines if the point identified by point_x and point_y falls inside this rectangle. </p>
<p>The point (x, y) is inside the rectangle, but the point (x + width, y + height) is not.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">point_x</td><td>An float value representing a x value. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">point_y</td><td>An float value representing a y value.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the point_x and point_y fall inside the rectangle. </dd></dl>
</div>
</div>
<a class="anchor" id="a82eaf22456cdf77d6a588ae86e4e86f9"></a><!-- doxytag: member="pp::FloatRect::Contains" ref="a82eaf22456cdf77d6a588ae86e4e86f9" args="(const FloatPoint &amp;point) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classpp_1_1_float_rect.html#a82bd21c4fc823d212a7526c2f03e3d43">pp::FloatRect::Contains</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_float_point.html">FloatPoint</a> &amp;&#160;</td>
<td class="paramname"><em>point</em></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classpp_1_1_float_rect.html#a82bd21c4fc823d212a7526c2f03e3d43" title="Contains() determines if the point identified by point_x and point_y falls inside this rectangle...">Contains()</a> determines if the specified point is contained by this rectangle. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">point</td><td>A pointer to a <a class="el" href="classpp_1_1_point.html" title="A 2 dimensional point with 0,0 being the upper-left starting coordinate.">Point</a> representing a 2D coordinate.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the point_x and point_y fall inside the rectangle. </dd></dl>
</div>
</div>
<a class="anchor" id="afcdf6b7eb8e1b931ac482c973af9fa9e"></a><!-- doxytag: member="pp::FloatRect::Contains" ref="afcdf6b7eb8e1b931ac482c973af9fa9e" args="(const FloatRect &amp;rect) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classpp_1_1_float_rect.html#a82bd21c4fc823d212a7526c2f03e3d43">pp::FloatRect::Contains</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_float_rect.html">FloatRect</a> &amp;&#160;</td>
<td class="paramname"><em>rect</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classpp_1_1_float_rect.html#a82bd21c4fc823d212a7526c2f03e3d43" title="Contains() determines if the point identified by point_x and point_y falls inside this rectangle...">Contains()</a> determines if this rectangle contains the specified rectangle. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">rect</td><td>A pointer to a <code><a class="el" href="classpp_1_1_float_rect.html" title="A 2 dimensional rectangle.">FloatRect</a></code>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the rectangle fall inside this rectangle. </dd></dl>
</div>
</div>
<a class="anchor" id="aee27f20031234762c710d441bc0cd148"></a><!-- doxytag: member="pp::FloatRect::Floatsize" ref="aee27f20031234762c710d441bc0cd148" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_float_size.html">FloatSize</a> <a class="el" href="classpp_1_1_float_rect.html#aee27f20031234762c710d441bc0cd148">pp::FloatRect::Floatsize</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Getter function for returning the <code><a class="el" href="classpp_1_1_float_size.html" title="A size of an object based on width and height.">FloatSize</a></code>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The size of the rectangle. </dd></dl>
</div>
</div>
<a class="anchor" id="a9dc3d3004aacf708356a73e09d1cc96e"></a><!-- doxytag: member="pp::FloatRect::height" ref="a9dc3d3004aacf708356a73e09d1cc96e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float <a class="el" href="classpp_1_1_float_rect.html#a9dc3d3004aacf708356a73e09d1cc96e">pp::FloatRect::height</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Getter function for returning the value of height. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The value of height for this <code><a class="el" href="classpp_1_1_float_rect.html" title="A 2 dimensional rectangle.">FloatRect</a></code>. </dd></dl>
</div>
</div>
<a class="anchor" id="a2d8abde94cff6a5813c2849dce42d707"></a><!-- doxytag: member="pp::FloatRect::Inset" ref="a2d8abde94cff6a5813c2849dce42d707" args="(float horizontal, float vertical)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classpp_1_1_float_rect.html#a2d8abde94cff6a5813c2849dce42d707">pp::FloatRect::Inset</a> </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>horizontal</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>vertical</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classpp_1_1_float_rect.html#a2d8abde94cff6a5813c2849dce42d707" title="Inset() shrinks the rectangle by a horizontal and vertical distance on all sides.">Inset()</a> shrinks the rectangle by a horizontal and vertical distance on all sides. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">horizontal</td><td>An float value representing a horizontal shrinking distance. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">vertical</td><td>An float value representing a vertical shrinking distance. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a24f94c63d2f097bd7f8b45a2c375077c"></a><!-- doxytag: member="pp::FloatRect::Inset" ref="a24f94c63d2f097bd7f8b45a2c375077c" args="(float left, float top, float right, float bottom)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classpp_1_1_float_rect.html#a2d8abde94cff6a5813c2849dce42d707">pp::FloatRect::Inset</a> </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>left</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>top</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>right</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>bottom</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classpp_1_1_float_rect.html#a2d8abde94cff6a5813c2849dce42d707" title="Inset() shrinks the rectangle by a horizontal and vertical distance on all sides.">Inset()</a> shrinks the rectangle by the specified amount on each side. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">left</td><td>An float value representing a left shrinking distance. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">top</td><td>An float value representing a top shrinking distance. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">right</td><td>An float value representing a right shrinking distance. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">bottom</td><td>An float value representing a bottom shrinking distance. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a6529366c00323c6d6495f3db14906ce8"></a><!-- doxytag: member="pp::FloatRect::Intersect" ref="a6529366c00323c6d6495f3db14906ce8" args="(const FloatRect &amp;rect) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_float_rect.html">FloatRect</a> <a class="el" href="classpp_1_1_float_rect.html#a6529366c00323c6d6495f3db14906ce8">pp::FloatRect::Intersect</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_float_rect.html">FloatRect</a> &amp;&#160;</td>
<td class="paramname"><em>rect</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classpp_1_1_float_rect.html#a6529366c00323c6d6495f3db14906ce8" title="Intersect() computes the intersection of this rectangle with the given rectangle.">Intersect()</a> computes the intersection of this rectangle with the given rectangle. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">rect</td><td>A pointer to a <code><a class="el" href="classpp_1_1_float_rect.html" title="A 2 dimensional rectangle.">FloatRect</a></code>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <code><a class="el" href="classpp_1_1_float_rect.html" title="A 2 dimensional rectangle.">FloatRect</a></code> representing the intersection. </dd></dl>
</div>
</div>
<a class="anchor" id="a701e3ca1e1cbd0ee10c432effb119088"></a><!-- doxytag: member="pp::FloatRect::Intersects" ref="a701e3ca1e1cbd0ee10c432effb119088" args="(const FloatRect &amp;rect) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classpp_1_1_float_rect.html#a701e3ca1e1cbd0ee10c432effb119088">pp::FloatRect::Intersects</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_float_rect.html">FloatRect</a> &amp;&#160;</td>
<td class="paramname"><em>rect</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classpp_1_1_float_rect.html#a701e3ca1e1cbd0ee10c432effb119088" title="Intersects() determines if this rectangle intersects the specified rectangle.">Intersects()</a> determines if this rectangle intersects the specified rectangle. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">rect</td><td>A pointer to a <code><a class="el" href="classpp_1_1_float_rect.html" title="A 2 dimensional rectangle.">FloatRect</a></code>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the rectangle intersects this rectangle. </dd></dl>
</div>
</div>
<a class="anchor" id="a73c6f15d2c2ed26a2bd8893efeab1dcb"></a><!-- doxytag: member="pp::FloatRect::IsEmpty" ref="a73c6f15d2c2ed26a2bd8893efeab1dcb" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classpp_1_1_float_rect.html#a73c6f15d2c2ed26a2bd8893efeab1dcb">pp::FloatRect::IsEmpty</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classpp_1_1_float_rect.html#a73c6f15d2c2ed26a2bd8893efeab1dcb" title="IsEmpty() determines if the area of a rectangle is zero.">IsEmpty()</a> determines if the area of a rectangle is zero. </p>
<p>Returns true if the area of the rectangle is zero.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the area of the rectangle is zero. </dd></dl>
</div>
</div>
<a class="anchor" id="a9b5247961b45da6dc5c656b906462f8b"></a><!-- doxytag: member="pp::FloatRect::Offset" ref="a9b5247961b45da6dc5c656b906462f8b" args="(float horizontal, float vertical)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classpp_1_1_float_rect.html#a9b5247961b45da6dc5c656b906462f8b">pp::FloatRect::Offset</a> </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>horizontal</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>vertical</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classpp_1_1_float_rect.html#a9b5247961b45da6dc5c656b906462f8b" title="Offset() moves the rectangle by a horizontal and vertical distance.">Offset()</a> moves the rectangle by a horizontal and vertical distance. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">horizontal</td><td>An float value representing a horizontal move distance. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">vertical</td><td>An float value representing a vertical move distance. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a60fce18269499d5c9f8c2446319844c3"></a><!-- doxytag: member="pp::FloatRect::Offset" ref="a60fce18269499d5c9f8c2446319844c3" args="(const FloatPoint &amp;point)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classpp_1_1_float_rect.html#a9b5247961b45da6dc5c656b906462f8b">pp::FloatRect::Offset</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_float_point.html">FloatPoint</a> &amp;&#160;</td>
<td class="paramname"><em>point</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classpp_1_1_float_rect.html#a9b5247961b45da6dc5c656b906462f8b" title="Offset() moves the rectangle by a horizontal and vertical distance.">Offset()</a> moves the rectangle by a horizontal and vertical distance. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">point</td><td>A pointer to a <code><a class="el" href="classpp_1_1_float_point.html" title="A 2 dimensional floating-point point with 0,0 being the upper-left starting coordinate.">FloatPoint</a></code> representing the horizontal and vertical move distances. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a85c34bdfd11703d4cc86486b3f38a032"></a><!-- doxytag: member="pp::FloatRect::operator PP_FloatRect" ref="a85c34bdfd11703d4cc86486b3f38a032" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">pp::FloatRect::operator PP_FloatRect </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>PP_FloatRect() allows implicit conversion of a <code><a class="el" href="classpp_1_1_float_rect.html" title="A 2 dimensional rectangle.">FloatRect</a></code> to a <code>PP_FloatRect</code>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <code><a class="el" href="classpp_1_1_point.html" title="A 2 dimensional point with 0,0 being the upper-left starting coordinate.">Point</a></code>. </dd></dl>
</div>
</div>
<a class="anchor" id="ae3f310aaeb5634e9f2ca7d51e35526a5"></a><!-- doxytag: member="pp::FloatRect::point" ref="ae3f310aaeb5634e9f2ca7d51e35526a5" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_float_point.html">FloatPoint</a> <a class="el" href="classpp_1_1_float_rect.html#ae3f310aaeb5634e9f2ca7d51e35526a5">pp::FloatRect::point</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Getter function for returning the <code><a class="el" href="classpp_1_1_float_point.html" title="A 2 dimensional floating-point point with 0,0 being the upper-left starting coordinate.">FloatPoint</a></code>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <code><a class="el" href="classpp_1_1_float_point.html" title="A 2 dimensional floating-point point with 0,0 being the upper-left starting coordinate.">FloatPoint</a></code>. </dd></dl>
</div>
</div>
<a class="anchor" id="aa63a6eab8caae819c7efb133b89e3ec2"></a><!-- doxytag: member="pp::FloatRect::pp_float_rect" ref="aa63a6eab8caae819c7efb133b89e3ec2" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const PP_FloatRect&amp; <a class="el" href="classpp_1_1_float_rect.html#aa63a6eab8caae819c7efb133b89e3ec2">pp::FloatRect::pp_float_rect</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Getter function for returning the internal <code>PP_FloatRect</code> struct. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A const reference to the internal <code>PP_FloatRect</code> struct. </dd></dl>
</div>
</div>
<a class="anchor" id="a796ff93f77b488ac673b0e82a2527507"></a><!-- doxytag: member="pp::FloatRect::pp_float_rect" ref="a796ff93f77b488ac673b0e82a2527507" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PP_FloatRect&amp; <a class="el" href="classpp_1_1_float_rect.html#aa63a6eab8caae819c7efb133b89e3ec2">pp::FloatRect::pp_float_rect</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Getter function for returning the internal <code>PP_FloatRect</code> struct. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A mutable reference to the <code>PP_FloatRect</code> struct. </dd></dl>
</div>
</div>
<a class="anchor" id="a34632c0a01c72fce447ac6b6f0cdf86b"></a><!-- doxytag: member="pp::FloatRect::right" ref="a34632c0a01c72fce447ac6b6f0cdf86b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float <a class="el" href="classpp_1_1_float_rect.html#a34632c0a01c72fce447ac6b6f0cdf86b">pp::FloatRect::right</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Getter function to get the upper-bound for the x-coordinates of the rectangle. </p>
<p>Note that this coordinate value is one past the highest x value of pixels in the rectangle. This loop will access all the pixels in a horizontal line in the rectangle: <code>for (float x = rect.x(); x &lt; rect.right(); ++x) {}</code></p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The value of x + width for this point. </dd></dl>
</div>
</div>
<a class="anchor" id="a81a0cc8fc8521167b34b10e75f94679f"></a><!-- doxytag: member="pp::FloatRect::set_height" ref="a81a0cc8fc8521167b34b10e75f94679f" args="(float h)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classpp_1_1_float_rect.html#a81a0cc8fc8521167b34b10e75f94679f">pp::FloatRect::set_height</a> </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>h</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Setter function for setting the value of height. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">h</td><td>A new width height. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a80c403de88c32d76c0a774e2af5c4973"></a><!-- doxytag: member="pp::FloatRect::set_point" ref="a80c403de88c32d76c0a774e2af5c4973" args="(const FloatPoint &amp;origin)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classpp_1_1_float_rect.html#a80c403de88c32d76c0a774e2af5c4973">pp::FloatRect::set_point</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_float_point.html">FloatPoint</a> &amp;&#160;</td>
<td class="paramname"><em>origin</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Setter function for setting the value of the <code><a class="el" href="classpp_1_1_float_point.html" title="A 2 dimensional floating-point point with 0,0 being the upper-left starting coordinate.">FloatPoint</a></code>. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">origin</td><td>A <code><a class="el" href="classpp_1_1_float_point.html" title="A 2 dimensional floating-point point with 0,0 being the upper-left starting coordinate.">FloatPoint</a></code> representing the upper-left starting coordinate. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a132796b0ca75d600509731d8c5a83736"></a><!-- doxytag: member="pp::FloatRect::set_size" ref="a132796b0ca75d600509731d8c5a83736" args="(const FloatSize &amp;s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classpp_1_1_float_rect.html#a132796b0ca75d600509731d8c5a83736">pp::FloatRect::set_size</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_float_size.html">FloatSize</a> &amp;&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Setter function for setting the <code><a class="el" href="classpp_1_1_float_size.html" title="A size of an object based on width and height.">FloatSize</a></code>. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>A pointer to a <code><a class="el" href="classpp_1_1_float_size.html" title="A size of an object based on width and height.">FloatSize</a></code> representing the height and width. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a9553c5bf8b2c00bc9eeb7a7c2c22d0f7"></a><!-- doxytag: member="pp::FloatRect::set_width" ref="a9553c5bf8b2c00bc9eeb7a7c2c22d0f7" args="(float w)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classpp_1_1_float_rect.html#a9553c5bf8b2c00bc9eeb7a7c2c22d0f7">pp::FloatRect::set_width</a> </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>w</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Setter function for setting the value of width. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">w</td><td>A new width value. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a52ed4022d98fc75e2bfd942ba0fb982f"></a><!-- doxytag: member="pp::FloatRect::set_x" ref="a52ed4022d98fc75e2bfd942ba0fb982f" args="(float in_x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classpp_1_1_float_rect.html#a52ed4022d98fc75e2bfd942ba0fb982f">pp::FloatRect::set_x</a> </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>in_x</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Setter function for setting the value of x. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">in_x</td><td>A new x value. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3b3a43a2764b7c0b6e6fad7bed300164"></a><!-- doxytag: member="pp::FloatRect::set_y" ref="a3b3a43a2764b7c0b6e6fad7bed300164" args="(float in_y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classpp_1_1_float_rect.html#a3b3a43a2764b7c0b6e6fad7bed300164">pp::FloatRect::set_y</a> </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>in_y</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Setter function for setting the value of y. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">in_y</td><td>A new y value. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="acfadd4bca5c16f05d138e4074b557df2"></a><!-- doxytag: member="pp::FloatRect::SetRect" ref="acfadd4bca5c16f05d138e4074b557df2" args="(float x, float y, float w, float h)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classpp_1_1_float_rect.html#acfadd4bca5c16f05d138e4074b557df2">pp::FloatRect::SetRect</a> </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>w</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>h</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Setter function for setting the value of the <code><a class="el" href="classpp_1_1_float_rect.html" title="A 2 dimensional rectangle.">FloatRect</a></code>. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>A new x value. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>A new y value. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">w</td><td>A new width value. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">h</td><td>A new height value. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ae5c915a40cd7689798c7395824132117"></a><!-- doxytag: member="pp::FloatRect::SetRect" ref="ae5c915a40cd7689798c7395824132117" args="(const PP_FloatRect &amp;rect)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classpp_1_1_float_rect.html#acfadd4bca5c16f05d138e4074b557df2">pp::FloatRect::SetRect</a> </td>
<td>(</td>
<td class="paramtype">const PP_FloatRect &amp;&#160;</td>
<td class="paramname"><em>rect</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Setter function for setting the value of the <code><a class="el" href="classpp_1_1_float_rect.html" title="A 2 dimensional rectangle.">FloatRect</a></code>. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">rect</td><td>A pointer to a <code>PP_FloatRect</code>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a9ab2652f39dc26de8c6750cc8d75d66a"></a><!-- doxytag: member="pp::FloatRect::SharesEdgeWith" ref="a9ab2652f39dc26de8c6750cc8d75d66a" args="(const FloatRect &amp;rect) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classpp_1_1_float_rect.html#a9ab2652f39dc26de8c6750cc8d75d66a">pp::FloatRect::SharesEdgeWith</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_float_rect.html">FloatRect</a> &amp;&#160;</td>
<td class="paramname"><em>rect</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classpp_1_1_float_rect.html#a9ab2652f39dc26de8c6750cc8d75d66a" title="SharesEdgeWith() determines if this rectangle shares an entire edge (same width or same height) with ...">SharesEdgeWith()</a> determines if this rectangle shares an entire edge (same width or same height) with the given rectangle, and the rectangles do not overlap. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">rect</td><td>A pointer to a <code><a class="el" href="classpp_1_1_float_rect.html" title="A 2 dimensional rectangle.">FloatRect</a></code>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if this rectangle and supplied rectangle share an edge. </dd></dl>
</div>
</div>
<a class="anchor" id="a8b1c8031d1442dfcc0d11ea75b396683"></a><!-- doxytag: member="pp::FloatRect::Subtract" ref="a8b1c8031d1442dfcc0d11ea75b396683" args="(const FloatRect &amp;rect) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_float_rect.html">FloatRect</a> <a class="el" href="classpp_1_1_float_rect.html#a8b1c8031d1442dfcc0d11ea75b396683">pp::FloatRect::Subtract</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_float_rect.html">FloatRect</a> &amp;&#160;</td>
<td class="paramname"><em>rect</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classpp_1_1_float_rect.html#a8b1c8031d1442dfcc0d11ea75b396683" title="Subtract() computes the rectangle resulting from subtracting rect from this Rect.">Subtract()</a> computes the rectangle resulting from subtracting <code>rect</code> from this <a class="el" href="classpp_1_1_rect.html" title="A 2 dimensional rectangle.">Rect</a>. </p>
<p>If <code>rect</code>does not intersect completely in either the x or y direction, then <code>*this</code> is returned. If <code>rect</code> contains <code>this</code>, then an empty <code><a class="el" href="classpp_1_1_rect.html" title="A 2 dimensional rectangle.">Rect</a></code> is returned.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">rect</td><td>A pointer to a <code><a class="el" href="classpp_1_1_float_rect.html" title="A 2 dimensional rectangle.">FloatRect</a></code>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <code><a class="el" href="classpp_1_1_float_rect.html" title="A 2 dimensional rectangle.">FloatRect</a></code> representing the subtraction. </dd></dl>
</div>
</div>
<a class="anchor" id="abb13835e0dbea82794cd4fa9140adb1e"></a><!-- doxytag: member="pp::FloatRect::Union" ref="abb13835e0dbea82794cd4fa9140adb1e" args="(const FloatRect &amp;rect) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_float_rect.html">FloatRect</a> <a class="el" href="classpp_1_1_float_rect.html#abb13835e0dbea82794cd4fa9140adb1e">pp::FloatRect::Union</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_float_rect.html">FloatRect</a> &amp;&#160;</td>
<td class="paramname"><em>rect</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classpp_1_1_float_rect.html#abb13835e0dbea82794cd4fa9140adb1e" title="Union() computes the union of this rectangle with the given rectangle.">Union()</a> computes the union of this rectangle with the given rectangle. </p>
<p>The union is the smallest rectangle containing both rectangles.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">rect</td><td>A pointer to a <code><a class="el" href="classpp_1_1_float_rect.html" title="A 2 dimensional rectangle.">FloatRect</a></code>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <code><a class="el" href="classpp_1_1_float_rect.html" title="A 2 dimensional rectangle.">FloatRect</a></code> representing the union. </dd></dl>
</div>
</div>
<a class="anchor" id="a25ffcc41df9f488acf15613f20e240db"></a><!-- doxytag: member="pp::FloatRect::width" ref="a25ffcc41df9f488acf15613f20e240db" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float <a class="el" href="classpp_1_1_float_rect.html#a25ffcc41df9f488acf15613f20e240db">pp::FloatRect::width</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Getter function for returning the value of width. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The value of width for this <code><a class="el" href="classpp_1_1_float_rect.html" title="A 2 dimensional rectangle.">FloatRect</a></code>. </dd></dl>
</div>
</div>
<a class="anchor" id="a4820c673dc07e6b35f8fc0c42368e92c"></a><!-- doxytag: member="pp::FloatRect::x" ref="a4820c673dc07e6b35f8fc0c42368e92c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float <a class="el" href="classpp_1_1_float_rect.html#a4820c673dc07e6b35f8fc0c42368e92c">pp::FloatRect::x</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Getter function for returning the value of x. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The value of x for this <code><a class="el" href="classpp_1_1_float_point.html" title="A 2 dimensional floating-point point with 0,0 being the upper-left starting coordinate.">FloatPoint</a></code>. </dd></dl>
</div>
</div>
<a class="anchor" id="ae31847965339e36aa1fe6c4cf8cf479c"></a><!-- doxytag: member="pp::FloatRect::y" ref="ae31847965339e36aa1fe6c4cf8cf479c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float <a class="el" href="classpp_1_1_float_rect.html#ae31847965339e36aa1fe6c4cf8cf479c">pp::FloatRect::y</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Getter function for returning the value of y. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The value of y for this <code><a class="el" href="classpp_1_1_float_point.html" title="A 2 dimensional floating-point point with 0,0 being the upper-left starting coordinate.">FloatPoint</a></code>. </dd></dl>
</div>
</div>
<hr />The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="rect_8h.html">rect.h</a></li>
</ul>
</div><!-- contents -->
</div>
{{/partials.standard_nacl_api}}