1 {{+bindTo:partials.standard_nacl_article}}
2 <h1>pp::FloatPoint Class Reference</h1>
4 {{- dummy div to appease doxygen -}}
6 <!-- Generated by Doxygen 1.7.6.1 -->
12 <div class="contents">
13 <!-- doxytag: class="pp::FloatPoint" -->
14 <p><a href="classpp_1_1_float_point-members.html">List of all members.</a></p>
16 Public Member Functions</h2><table class="memberdecls">
18 <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_point.html#a384b29d8aba4a43b399393e695eb1e81">FloatPoint</a> ()</td></tr>
19 <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_point.html#acb70a23a641f05fd5eb99e9439e556d2">FloatPoint</a> (float in_x, float in_y)</td></tr>
20 <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_point.html#a401fc74a911cd0d4996b00f8b10a1951">FloatPoint</a> (const PP_FloatPoint &point)</td></tr>
21 <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_point.html#ab41958133c5b48f6002ad9bffdad46c0">~FloatPoint</a> ()</td></tr>
22 <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_point.html#adfa14cbb4f94c3133e4bce72f93570bf">operator PP_FloatPoint</a> () const </td></tr>
23 <tr><td class="memItemLeft" align="right" valign="top">const PP_FloatPoint & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_point.html#a74112618552ed91f200794127bf64eea">pp_float_point</a> () const </td></tr>
24 <tr><td class="memItemLeft" align="right" valign="top">PP_FloatPoint & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_point.html#a75ab7bd430e1f5edb00d9976061898ed">pp_float_point</a> ()</td></tr>
25 <tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_point.html#a9109ddb0920cf0eeb7ace3b40a95dc17">x</a> () const </td></tr>
26 <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_point.html#a276b372b82ea3cd0021017ba4a002838">set_x</a> (float in_x)</td></tr>
27 <tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_point.html#ac8bcb2ac55fa5fcf89a7b61369eeed2b">y</a> () const </td></tr>
28 <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_point.html#abdb8eeb5c2aa051e6776ae2967fc6d40">set_y</a> (float in_y)</td></tr>
29 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_float_point.html">FloatPoint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_point.html#a8aeaf7286bc04e7ff7f9d405fdfe614b">operator+</a> (const <a class="el" href="classpp_1_1_float_point.html">FloatPoint</a> &other) const </td></tr>
30 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_float_point.html">FloatPoint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_point.html#a2ae33c7eb2dbc4a8d366db080f3a136b">operator-</a> (const <a class="el" href="classpp_1_1_float_point.html">FloatPoint</a> &other) const </td></tr>
31 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_float_point.html">FloatPoint</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_point.html#a15985b03ca98d65bdf300dc3d12ca57a">operator+=</a> (const <a class="el" href="classpp_1_1_float_point.html">FloatPoint</a> &other)</td></tr>
32 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_float_point.html">FloatPoint</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_point.html#a419049446659935f8bfe3e47d33b752b">operator-=</a> (const <a class="el" href="classpp_1_1_float_point.html">FloatPoint</a> &other)</td></tr>
33 <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_float_point.html#a138f26f94ed5a97e1ee083e65eb101bf">swap</a> (<a class="el" href="classpp_1_1_float_point.html">FloatPoint</a> &other)</td></tr>
35 <hr /><a name="details" id="details"></a><h2>Detailed Description</h2>
36 <div class="textblock"><p>A 2 dimensional floating-point point with 0,0 being the upper-left starting coordinate. </p>
37 </div><hr /><h2>Constructor & Destructor Documentation</h2>
38 <a class="anchor" id="a384b29d8aba4a43b399393e695eb1e81"></a><!-- doxytag: member="pp::FloatPoint::FloatPoint" ref="a384b29d8aba4a43b399393e695eb1e81" args="()" -->
40 <div class="memproto">
41 <table class="memname">
43 <td class="memname"><a class="el" href="classpp_1_1_float_point.html#a384b29d8aba4a43b399393e695eb1e81">pp::FloatPoint::FloatPoint</a> </td>
45 <td class="paramname"></td><td>)</td>
46 <td><code> [inline]</code></td>
51 <p>A constructor for a point at 0,0. </p>
54 <a class="anchor" id="acb70a23a641f05fd5eb99e9439e556d2"></a><!-- doxytag: member="pp::FloatPoint::FloatPoint" ref="acb70a23a641f05fd5eb99e9439e556d2" args="(float in_x, float in_y)" -->
56 <div class="memproto">
57 <table class="memname">
59 <td class="memname"><a class="el" href="classpp_1_1_float_point.html#a384b29d8aba4a43b399393e695eb1e81">pp::FloatPoint::FloatPoint</a> </td>
61 <td class="paramtype">float </td>
62 <td class="paramname"><em>in_x</em>, </td>
65 <td class="paramkey"></td>
67 <td class="paramtype">float </td>
68 <td class="paramname"><em>in_y</em> </td>
73 <td></td><td><code> [inline]</code></td>
78 <p>A constructor accepting two values for x and y and converting them to a <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>. </p>
79 <dl class="params"><dt><b>Parameters:</b></dt><dd>
80 <table class="params">
81 <tr><td class="paramdir">[in]</td><td class="paramname">in_x</td><td>An value representing a horizontal coordinate of a point, starting with 0 as the left-most coordinate.</td></tr>
82 <tr><td class="paramdir">[in]</td><td class="paramname">in_y</td><td>An value representing a vertical coordinate of a point, starting with 0 as the top-most coordinate. </td></tr>
88 <a class="anchor" id="a401fc74a911cd0d4996b00f8b10a1951"></a><!-- doxytag: member="pp::FloatPoint::FloatPoint" ref="a401fc74a911cd0d4996b00f8b10a1951" args="(const PP_FloatPoint &point)" -->
90 <div class="memproto">
91 <table class="memname">
93 <td class="memname"><a class="el" href="classpp_1_1_float_point.html#a384b29d8aba4a43b399393e695eb1e81">pp::FloatPoint::FloatPoint</a> </td>
95 <td class="paramtype">const PP_FloatPoint & </td>
96 <td class="paramname"><em>point</em></td><td>)</td>
97 <td><code> [inline]</code></td>
102 <p>A constructor accepting a pointer to a PP_FloatPoint and converting the PP_Point 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>. </p>
103 <p>This is an implicit conversion constructor.</p>
104 <dl class="params"><dt><b>Parameters:</b></dt><dd>
105 <table class="params">
106 <tr><td class="paramdir">[in]</td><td class="paramname">point</td><td>A PP_FloatPoint. </td></tr>
112 <a class="anchor" id="ab41958133c5b48f6002ad9bffdad46c0"></a><!-- doxytag: member="pp::FloatPoint::~FloatPoint" ref="ab41958133c5b48f6002ad9bffdad46c0" args="()" -->
113 <div class="memitem">
114 <div class="memproto">
115 <table class="memname">
117 <td class="memname"><a class="el" href="classpp_1_1_float_point.html#ab41958133c5b48f6002ad9bffdad46c0">pp::FloatPoint::~FloatPoint</a> </td>
119 <td class="paramname"></td><td>)</td>
120 <td><code> [inline]</code></td>
128 <hr /><h2>Member Function Documentation</h2>
129 <a class="anchor" id="adfa14cbb4f94c3133e4bce72f93570bf"></a><!-- doxytag: member="pp::FloatPoint::operator PP_FloatPoint" ref="adfa14cbb4f94c3133e4bce72f93570bf" args="() const " -->
130 <div class="memitem">
131 <div class="memproto">
132 <table class="memname">
134 <td class="memname">pp::FloatPoint::operator PP_FloatPoint </td>
136 <td class="paramname"></td><td>)</td>
137 <td> const<code> [inline]</code></td>
142 <p>A function allowing implicit conversion of a <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> to a PP_FloatPoint. </p>
145 <a class="anchor" id="a8aeaf7286bc04e7ff7f9d405fdfe614b"></a><!-- doxytag: member="pp::FloatPoint::operator+" ref="a8aeaf7286bc04e7ff7f9d405fdfe614b" args="(const FloatPoint &other) const " -->
146 <div class="memitem">
147 <div class="memproto">
148 <table class="memname">
150 <td class="memname"><a class="el" href="classpp_1_1_float_point.html">FloatPoint</a> pp::FloatPoint::operator+ </td>
152 <td class="paramtype">const <a class="el" href="classpp_1_1_float_point.html">FloatPoint</a> & </td>
153 <td class="paramname"><em>other</em></td><td>)</td>
154 <td> const<code> [inline]</code></td>
159 <p>Adds two Points (this and other) together by adding their x values and y values. </p>
160 <dl class="params"><dt><b>Parameters:</b></dt><dd>
161 <table class="params">
162 <tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>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>.</td></tr>
166 <dl class="return"><dt><b>Returns:</b></dt><dd>A new <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> containing the result. </dd></dl>
169 <a class="anchor" id="a15985b03ca98d65bdf300dc3d12ca57a"></a><!-- doxytag: member="pp::FloatPoint::operator+=" ref="a15985b03ca98d65bdf300dc3d12ca57a" args="(const FloatPoint &other)" -->
170 <div class="memitem">
171 <div class="memproto">
172 <table class="memname">
174 <td class="memname"><a class="el" href="classpp_1_1_float_point.html">FloatPoint</a>& pp::FloatPoint::operator+= </td>
176 <td class="paramtype">const <a class="el" href="classpp_1_1_float_point.html">FloatPoint</a> & </td>
177 <td class="paramname"><em>other</em></td><td>)</td>
178 <td><code> [inline]</code></td>
183 <p>Adds two Points (this and other) together by adding their x and y values. </p>
184 <p>Returns this point as the result.</p>
185 <dl class="params"><dt><b>Parameters:</b></dt><dd>
186 <table class="params">
187 <tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>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>.</td></tr>
191 <dl class="return"><dt><b>Returns:</b></dt><dd>This <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> containing the result. </dd></dl>
194 <a class="anchor" id="a2ae33c7eb2dbc4a8d366db080f3a136b"></a><!-- doxytag: member="pp::FloatPoint::operator-" ref="a2ae33c7eb2dbc4a8d366db080f3a136b" args="(const FloatPoint &other) const " -->
195 <div class="memitem">
196 <div class="memproto">
197 <table class="memname">
199 <td class="memname"><a class="el" href="classpp_1_1_float_point.html">FloatPoint</a> pp::FloatPoint::operator- </td>
201 <td class="paramtype">const <a class="el" href="classpp_1_1_float_point.html">FloatPoint</a> & </td>
202 <td class="paramname"><em>other</em></td><td>)</td>
203 <td> const<code> [inline]</code></td>
208 <p>Subtracts one <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> from another <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> by subtracting their x values and y values. </p>
209 <p>Returns a new point with the result.</p>
210 <dl class="params"><dt><b>Parameters:</b></dt><dd>
211 <table class="params">
212 <tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>A <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>.</td></tr>
216 <dl class="return"><dt><b>Returns:</b></dt><dd>A new <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> containing the result. </dd></dl>
219 <a class="anchor" id="a419049446659935f8bfe3e47d33b752b"></a><!-- doxytag: member="pp::FloatPoint::operator-=" ref="a419049446659935f8bfe3e47d33b752b" args="(const FloatPoint &other)" -->
220 <div class="memitem">
221 <div class="memproto">
222 <table class="memname">
224 <td class="memname"><a class="el" href="classpp_1_1_float_point.html">FloatPoint</a>& pp::FloatPoint::operator-= </td>
226 <td class="paramtype">const <a class="el" href="classpp_1_1_float_point.html">FloatPoint</a> & </td>
227 <td class="paramname"><em>other</em></td><td>)</td>
228 <td><code> [inline]</code></td>
233 <p>Subtracts one <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> from another <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> by subtracting their x values and y values. </p>
234 <p>Returns this point as the result.</p>
235 <dl class="params"><dt><b>Parameters:</b></dt><dd>
236 <table class="params">
237 <tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>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>.</td></tr>
241 <dl class="return"><dt><b>Returns:</b></dt><dd>This <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> containing the result. </dd></dl>
244 <a class="anchor" id="a74112618552ed91f200794127bf64eea"></a><!-- doxytag: member="pp::FloatPoint::pp_float_point" ref="a74112618552ed91f200794127bf64eea" args="() const " -->
245 <div class="memitem">
246 <div class="memproto">
247 <table class="memname">
249 <td class="memname">const PP_FloatPoint& <a class="el" href="classpp_1_1_float_point.html#a74112618552ed91f200794127bf64eea">pp::FloatPoint::pp_float_point</a> </td>
251 <td class="paramname"></td><td>)</td>
252 <td> const<code> [inline]</code></td>
257 <p>Getter function for returning the internal PP_FloatPoint struct. </p>
258 <dl class="return"><dt><b>Returns:</b></dt><dd>A const reference to the internal PP_FloatPoint struct. </dd></dl>
261 <a class="anchor" id="a75ab7bd430e1f5edb00d9976061898ed"></a><!-- doxytag: member="pp::FloatPoint::pp_float_point" ref="a75ab7bd430e1f5edb00d9976061898ed" args="()" -->
262 <div class="memitem">
263 <div class="memproto">
264 <table class="memname">
266 <td class="memname">PP_FloatPoint& <a class="el" href="classpp_1_1_float_point.html#a74112618552ed91f200794127bf64eea">pp::FloatPoint::pp_float_point</a> </td>
268 <td class="paramname"></td><td>)</td>
269 <td><code> [inline]</code></td>
274 <p>Getter function for returning the internal PP_Point struct. </p>
275 <dl class="return"><dt><b>Returns:</b></dt><dd>A mutable reference to the PP_Point struct. </dd></dl>
278 <a class="anchor" id="a276b372b82ea3cd0021017ba4a002838"></a><!-- doxytag: member="pp::FloatPoint::set_x" ref="a276b372b82ea3cd0021017ba4a002838" args="(float in_x)" -->
279 <div class="memitem">
280 <div class="memproto">
281 <table class="memname">
283 <td class="memname">void <a class="el" href="classpp_1_1_float_point.html#a276b372b82ea3cd0021017ba4a002838">pp::FloatPoint::set_x</a> </td>
285 <td class="paramtype">float </td>
286 <td class="paramname"><em>in_x</em></td><td>)</td>
287 <td><code> [inline]</code></td>
292 <p>Setter function for setting the value of x. </p>
293 <dl class="params"><dt><b>Parameters:</b></dt><dd>
294 <table class="params">
295 <tr><td class="paramdir">[in]</td><td class="paramname">in_x</td><td>A new x value. </td></tr>
301 <a class="anchor" id="abdb8eeb5c2aa051e6776ae2967fc6d40"></a><!-- doxytag: member="pp::FloatPoint::set_y" ref="abdb8eeb5c2aa051e6776ae2967fc6d40" args="(float in_y)" -->
302 <div class="memitem">
303 <div class="memproto">
304 <table class="memname">
306 <td class="memname">void <a class="el" href="classpp_1_1_float_point.html#abdb8eeb5c2aa051e6776ae2967fc6d40">pp::FloatPoint::set_y</a> </td>
308 <td class="paramtype">float </td>
309 <td class="paramname"><em>in_y</em></td><td>)</td>
310 <td><code> [inline]</code></td>
315 <p>Setter function for setting the value of y. </p>
316 <dl class="params"><dt><b>Parameters:</b></dt><dd>
317 <table class="params">
318 <tr><td class="paramdir">[in]</td><td class="paramname">in_y</td><td>A new y value. </td></tr>
324 <a class="anchor" id="a138f26f94ed5a97e1ee083e65eb101bf"></a><!-- doxytag: member="pp::FloatPoint::swap" ref="a138f26f94ed5a97e1ee083e65eb101bf" args="(FloatPoint &other)" -->
325 <div class="memitem">
326 <div class="memproto">
327 <table class="memname">
329 <td class="memname">void <a class="el" href="classpp_1_1_float_point.html#a138f26f94ed5a97e1ee083e65eb101bf">pp::FloatPoint::swap</a> </td>
331 <td class="paramtype"><a class="el" href="classpp_1_1_float_point.html">FloatPoint</a> & </td>
332 <td class="paramname"><em>other</em></td><td>)</td>
333 <td><code> [inline]</code></td>
338 <p>Swaps the coordinates of two Points. </p>
339 <dl class="params"><dt><b>Parameters:</b></dt><dd>
340 <table class="params">
341 <tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>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>. </td></tr>
347 <a class="anchor" id="a9109ddb0920cf0eeb7ace3b40a95dc17"></a><!-- doxytag: member="pp::FloatPoint::x" ref="a9109ddb0920cf0eeb7ace3b40a95dc17" args="() const " -->
348 <div class="memitem">
349 <div class="memproto">
350 <table class="memname">
352 <td class="memname">float <a class="el" href="classpp_1_1_float_point.html#a9109ddb0920cf0eeb7ace3b40a95dc17">pp::FloatPoint::x</a> </td>
354 <td class="paramname"></td><td>)</td>
355 <td> const<code> [inline]</code></td>
360 <p>Getter function for returning the value of x. </p>
361 <dl class="return"><dt><b>Returns:</b></dt><dd>The value of x for this <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>. </dd></dl>
364 <a class="anchor" id="ac8bcb2ac55fa5fcf89a7b61369eeed2b"></a><!-- doxytag: member="pp::FloatPoint::y" ref="ac8bcb2ac55fa5fcf89a7b61369eeed2b" args="() const " -->
365 <div class="memitem">
366 <div class="memproto">
367 <table class="memname">
369 <td class="memname">float <a class="el" href="classpp_1_1_float_point.html#ac8bcb2ac55fa5fcf89a7b61369eeed2b">pp::FloatPoint::y</a> </td>
371 <td class="paramname"></td><td>)</td>
372 <td> const<code> [inline]</code></td>
377 <p>Getter function for returning the value of y. </p>
378 <dl class="return"><dt><b>Returns:</b></dt><dd>The value of y for this <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>. </dd></dl>
381 <hr />The documentation for this class was generated from the following file:<ul>
382 <li><a class="el" href="point_8h.html">point.h</a></li>
384 </div><!-- contents -->
386 {{/partials.standard_nacl_article}}