classpp_1_1_float_size.html | Explore in Territory

{{+bindTo:partials.standard_nacl_api}}
<h1>pp::FloatSize 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::FloatSize" -->
<p><a href="classpp_1_1_float_size-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_size.html#a91414423a7cbbf8351411068bf421dd0">FloatSize</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_size.html#aa0e0d4226243d988ae0b3deda568b4aa">FloatSize</a> (const PP_FloatSize &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_size.html#a9c220e08fee17fc94c0f4be986dced9f">FloatSize</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_size.html#aa84f34b811eaa0d1df9df3e45ffcad62">~FloatSize</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_size.html#afb9299a590c01b087093f6ed92851e34">operator PP_FloatSize</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const PP_FloatSize &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_size.html#a7b6927a68a34300dd387e1c1a88f1ba1">pp_float_size</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">PP_FloatSize &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_size.html#ad498f68d6cdef2b82d36e86186b0dea8">pp_float_size</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_size.html#a0d6da88f00641c03bac5719e70120f60">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_size.html#a1ba0848cf46407dbd38faae98066d19b">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_size.html#a50b992d924016a21b105eb4188498fb5">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_size.html#ae97846a7d14b1c512908672277ea651c">set_height</a> (float h)</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_size.html#af853066f332b80b810be32f1b8a53088">GetArea</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_size.html#add235ac4ae08be3c14b3a0033e97b470">SetSize</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_size.html#a080710fed6678c639b1a894e88734fb6">Enlarge</a> (float w, float h)</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_size.html#a0528086304774d3024798a42ec559e79">IsEmpty</a> () const </td></tr>
</table>
<hr /><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A size of an object based on width and height. </p>
</div><hr /><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a91414423a7cbbf8351411068bf421dd0"></a><!-- doxytag: member="pp::FloatSize::FloatSize" ref="a91414423a7cbbf8351411068bf421dd0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_float_size.html#a91414423a7cbbf8351411068bf421dd0">pp::FloatSize::FloatSize</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. Initializes the width and height to 0.0f. </p>
</div>
</div>
<a class="anchor" id="aa0e0d4226243d988ae0b3deda568b4aa"></a><!-- doxytag: member="pp::FloatSize::FloatSize" ref="aa0e0d4226243d988ae0b3deda568b4aa" args="(const PP_FloatSize &amp;s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_float_size.html#a91414423a7cbbf8351411068bf421dd0">pp::FloatSize::FloatSize</a> </td>
<td>(</td>
<td class="paramtype">const PP_FloatSize &amp;&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A constructor accepting a pointer to a <code>PP_FloatSize</code> and converting the <code>PP_FloatSize</code> 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>. </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">s</td><td>A pointer to a <code>PP_FloatSize</code>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a9c220e08fee17fc94c0f4be986dced9f"></a><!-- doxytag: member="pp::FloatSize::FloatSize" ref="a9c220e08fee17fc94c0f4be986dced9f" 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_size.html#a91414423a7cbbf8351411068bf421dd0">pp::FloatSize::FloatSize</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_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">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="aa84f34b811eaa0d1df9df3e45ffcad62"></a><!-- doxytag: member="pp::FloatSize::~FloatSize" ref="aa84f34b811eaa0d1df9df3e45ffcad62" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_float_size.html#aa84f34b811eaa0d1df9df3e45ffcad62">pp::FloatSize::~FloatSize</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="a080710fed6678c639b1a894e88734fb6"></a><!-- doxytag: member="pp::FloatSize::Enlarge" ref="a080710fed6678c639b1a894e88734fb6" args="(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_size.html#a080710fed6678c639b1a894e88734fb6">pp::FloatSize::Enlarge</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 class="el" href="classpp_1_1_float_size.html#a080710fed6678c639b1a894e88734fb6" title="Enlarge() enlarges the size of an object.">Enlarge()</a> enlarges the size of an object. </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 width to add the current width. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">h</td><td>A height to add to the current height. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="af853066f332b80b810be32f1b8a53088"></a><!-- doxytag: member="pp::FloatSize::GetArea" ref="af853066f332b80b810be32f1b8a53088" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float <a class="el" href="classpp_1_1_float_size.html#af853066f332b80b810be32f1b8a53088">pp::FloatSize::GetArea</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_size.html#af853066f332b80b810be32f1b8a53088" title="GetArea() determines the area (width * height).">GetArea()</a> determines the area (width * height). </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The area. </dd></dl>
</div>
</div>
<a class="anchor" id="a50b992d924016a21b105eb4188498fb5"></a><!-- doxytag: member="pp::FloatSize::height" ref="a50b992d924016a21b105eb4188498fb5" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float <a class="el" href="classpp_1_1_float_size.html#a50b992d924016a21b105eb4188498fb5">pp::FloatSize::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_size.html" title="A size of an object based on width and height.">FloatSize</a></code>. </dd></dl>
</div>
</div>
<a class="anchor" id="a0528086304774d3024798a42ec559e79"></a><!-- doxytag: member="pp::FloatSize::IsEmpty" ref="a0528086304774d3024798a42ec559e79" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classpp_1_1_float_size.html#a0528086304774d3024798a42ec559e79">pp::FloatSize::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_size.html#a0528086304774d3024798a42ec559e79" title="IsEmpty() determines if the size is zero.">IsEmpty()</a> determines if the size is zero. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the size is zero. </dd></dl>
</div>
</div>
<a class="anchor" id="afb9299a590c01b087093f6ed92851e34"></a><!-- doxytag: member="pp::FloatSize::operator PP_FloatSize" ref="afb9299a590c01b087093f6ed92851e34" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">pp::FloatSize::operator PP_FloatSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>PP_FloatSize() allows implicit conversion of 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> to a <code>PP_FloatSize</code>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="classpp_1_1_size.html" title="A size of an object based on width and height.">Size</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="a7b6927a68a34300dd387e1c1a88f1ba1"></a><!-- doxytag: member="pp::FloatSize::pp_float_size" ref="a7b6927a68a34300dd387e1c1a88f1ba1" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const PP_FloatSize&amp; <a class="el" href="classpp_1_1_float_size.html#a7b6927a68a34300dd387e1c1a88f1ba1">pp::FloatSize::pp_float_size</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_FloatSize</code> struct. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A const reference to the internal <code>PP_FloatSize</code> struct. </dd></dl>
</div>
</div>
<a class="anchor" id="ad498f68d6cdef2b82d36e86186b0dea8"></a><!-- doxytag: member="pp::FloatSize::pp_float_size" ref="ad498f68d6cdef2b82d36e86186b0dea8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PP_FloatSize&amp; <a class="el" href="classpp_1_1_float_size.html#a7b6927a68a34300dd387e1c1a88f1ba1">pp::FloatSize::pp_float_size</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_FloatSize</code> struct. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A mutable reference to the <code>PP_FloatSize</code> struct. </dd></dl>
</div>
</div>
<a class="anchor" id="ae97846a7d14b1c512908672277ea651c"></a><!-- doxytag: member="pp::FloatSize::set_height" ref="ae97846a7d14b1c512908672277ea651c" 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_size.html#ae97846a7d14b1c512908672277ea651c">pp::FloatSize::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 height value. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1ba0848cf46407dbd38faae98066d19b"></a><!-- doxytag: member="pp::FloatSize::set_width" ref="a1ba0848cf46407dbd38faae98066d19b" 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_size.html#a1ba0848cf46407dbd38faae98066d19b">pp::FloatSize::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="add235ac4ae08be3c14b3a0033e97b470"></a><!-- doxytag: member="pp::FloatSize::SetSize" ref="add235ac4ae08be3c14b3a0033e97b470" args="(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_size.html#add235ac4ae08be3c14b3a0033e97b470">pp::FloatSize::SetSize</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 class="el" href="classpp_1_1_float_size.html#add235ac4ae08be3c14b3a0033e97b470" title="SetSize() sets the value of width and height.">SetSize()</a> sets the value of width and height. </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>
<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="a0d6da88f00641c03bac5719e70120f60"></a><!-- doxytag: member="pp::FloatSize::width" ref="a0d6da88f00641c03bac5719e70120f60" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float <a class="el" href="classpp_1_1_float_size.html#a0d6da88f00641c03bac5719e70120f60">pp::FloatSize::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_size.html" title="A size of an object based on width and height.">FloatSize</a></code>. </dd></dl>
</div>
</div>
<hr />The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="size_8h.html">size.h</a></li>
</ul>
</div><!-- contents -->
</div>
{{/partials.standard_nacl_api}}
chromium/native_client_sdk/doc_generated/pepper_stable/cpp/classpp_1_1_float_size.html
