blob: 3de36f03ddad1d90b22d1806b2dec58163e5669f [file] [log] [blame]
{{+bindTo:partials.standard_nacl_api}}
<h1>pp::TouchPoint 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::TouchPoint" -->
<p><a href="classpp_1_1_touch_point-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_touch_point.html#a76b04de6cd756e80d3b039988faed697">TouchPoint</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_touch_point.html#affadca4389137e288a0a9a53019a2211">TouchPoint</a> (const PP_TouchPoint &amp;point)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_touch_point.html#a9bc0e1ce3579b52927da1104646b994b">id</a> () 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_touch_point.html#aa4a407b747e9c523844eba4aaf861773">position</a> () 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_touch_point.html#a92f3376a9db010e20bed4a5fe3e42f0f">radii</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_touch_point.html#a82c6f0f579e30d37d0f14cdbb3ca9177">rotation_angle</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_touch_point.html#a4e09d5e4a892da9f6b32c9986a25376c">pressure</a> () const </td></tr>
</table>
<hr /><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Wrapper class for PP_TouchPoint. </p>
</div><hr /><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a76b04de6cd756e80d3b039988faed697"></a><!-- doxytag: member="pp::TouchPoint::TouchPoint" ref="a76b04de6cd756e80d3b039988faed697" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_touch_point.html#a76b04de6cd756e80d3b039988faed697">pp::TouchPoint::TouchPoint</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="affadca4389137e288a0a9a53019a2211"></a><!-- doxytag: member="pp::TouchPoint::TouchPoint" ref="affadca4389137e288a0a9a53019a2211" args="(const PP_TouchPoint &amp;point)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_touch_point.html#a76b04de6cd756e80d3b039988faed697">pp::TouchPoint::TouchPoint</a> </td>
<td>(</td>
<td class="paramtype">const PP_TouchPoint &amp;&#160;</td>
<td class="paramname"><em>point</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr /><h2>Member Function Documentation</h2>
<a class="anchor" id="a9bc0e1ce3579b52927da1104646b994b"></a><!-- doxytag: member="pp::TouchPoint::id" ref="a9bc0e1ce3579b52927da1104646b994b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t <a class="el" href="classpp_1_1_touch_point.html#a9bc0e1ce3579b52927da1104646b994b">pp::TouchPoint::id</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>The identifier for this <a class="el" href="classpp_1_1_touch_point.html" title="Wrapper class for PP_TouchPoint.">TouchPoint</a>. This corresponds to the order in which the points were pressed. For example, the first point to be pressed has an id of 0, the second has an id of 1, and so on. An id can be reused when a touch point is released. For example, if two fingers are down, with id 0 and 1, and finger 0 releases, the next finger to be pressed can be assigned to id 0. </dd></dl>
</div>
</div>
<a class="anchor" id="aa4a407b747e9c523844eba4aaf861773"></a><!-- doxytag: member="pp::TouchPoint::position" ref="aa4a407b747e9c523844eba4aaf861773" 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_touch_point.html#aa4a407b747e9c523844eba4aaf861773">pp::TouchPoint::position</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>The x-y coordinates of this <a class="el" href="classpp_1_1_touch_point.html" title="Wrapper class for PP_TouchPoint.">TouchPoint</a>, in DOM coordinate space. </dd></dl>
</div>
</div>
<a class="anchor" id="a4e09d5e4a892da9f6b32c9986a25376c"></a><!-- doxytag: member="pp::TouchPoint::pressure" ref="a4e09d5e4a892da9f6b32c9986a25376c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float <a class="el" href="classpp_1_1_touch_point.html#a4e09d5e4a892da9f6b32c9986a25376c">pp::TouchPoint::pressure</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>The pressure applied to this <a class="el" href="classpp_1_1_touch_point.html" title="Wrapper class for PP_TouchPoint.">TouchPoint</a>. This is typically a value between 0 and 1, with 0 indicating no pressure and 1 indicating some maximum pressure, but scaling differs depending on the hardware and the value is not guaranteed to stay within that range. </dd></dl>
</div>
</div>
<a class="anchor" id="a92f3376a9db010e20bed4a5fe3e42f0f"></a><!-- doxytag: member="pp::TouchPoint::radii" ref="a92f3376a9db010e20bed4a5fe3e42f0f" 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_touch_point.html#a92f3376a9db010e20bed4a5fe3e42f0f">pp::TouchPoint::radii</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>The elliptical radii, in screen pixels, in the x and y direction of this <a class="el" href="classpp_1_1_touch_point.html" title="Wrapper class for PP_TouchPoint.">TouchPoint</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="a82c6f0f579e30d37d0f14cdbb3ca9177"></a><!-- doxytag: member="pp::TouchPoint::rotation_angle" ref="a82c6f0f579e30d37d0f14cdbb3ca9177" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float <a class="el" href="classpp_1_1_touch_point.html#a82c6f0f579e30d37d0f14cdbb3ca9177">pp::TouchPoint::rotation_angle</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>The angle of rotation of the elliptical model of this <a class="el" href="classpp_1_1_touch_point.html" title="Wrapper class for PP_TouchPoint.">TouchPoint</a> from the y-axis. </dd></dl>
</div>
</div>
<hr />The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="touch__point_8h.html">touch_point.h</a></li>
</ul>
</div><!-- contents -->
</div>
{{/partials.standard_nacl_api}}