<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qaccelerometer.cpp -->
<title>QAccelerometer Class | Qt Sensors 5.9</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.9</td><td ><a href="qtsensors-index.html">Qt Sensors</a></td><td ><a href="qtsensors-module.html">C++ Classes</a></td><td >QAccelerometer</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.4 Reference Documentation</td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QAccelerometer Class</h1>
<!-- $$$QAccelerometer-brief -->
<p>The <a href="qaccelerometer.html">QAccelerometer</a> class is a convenience wrapper around <a href="qsensor.html">QSensor</a>. <a href="#details">More...</a></p>
<!-- @@@QAccelerometer -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QAccelerometer></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += sensors</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qsensor.html">QSensor</a></td></tr></table></div><ul>
<li><a href="qaccelerometer-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2 id="public-types">Public Types</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qaccelerometer.html#AccelerationMode-enum">AccelerationMode</a></b> { Combined, Gravity, User }</td></tr>
</table></div>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><a href="qaccelerometer.html#accelerationMode-prop">accelerationMode</a></b> : AccelerationMode</li>
</ul>
<ul>
<li class="fn">20 properties inherited from <a href="qsensor.html#properties">QSensor</a></li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qaccelerometer.html#QAccelerometer">QAccelerometer</a></b>(QObject *<i>parent</i> = Q_NULLPTR)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qaccelerometer.html#dtor.QAccelerometer">~QAccelerometer</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> AccelerationMode </td><td class="memItemRight bottomAlign"><b><a href="qaccelerometer.html#accelerationMode-prop">accelerationMode</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QAccelerometerReading *</td><td class="memItemRight bottomAlign"><b><a href="qaccelerometer.html#reading">reading</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaccelerometer.html#setAccelerationMode">setAccelerationMode</a></b>(AccelerationMode <i>accelerationMode</i>)</td></tr>
</table></div>
<ul>
<li class="fn">37 public functions inherited from <a href="qsensor.html#public-functions">QSensor</a></li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaccelerometer.html#accelerationModeChanged">accelerationModeChanged</a></b>(AccelerationMode <i>accelerationMode</i>)</td></tr>
</table></div>
<ul>
<li class="fn">14 signals inherited from <a href="qsensor.html#signals">QSensor</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">2 public slots inherited from <a href="qsensor.html#public-slots">QSensor</a></li>
<li class="fn">3 static public members inherited from <a href="qsensor.html#static-public-members">QSensor</a></li>
</ul>
<a name="details"></a>
<!-- $$$QAccelerometer-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qaccelerometer.html">QAccelerometer</a> class is a convenience wrapper around <a href="qsensor.html">QSensor</a>.</p>
<p>The only behavioural difference is that this class sets the type properly.</p>
<p>It also supports changing the acceleration mode, which controls whether the force of gravity is included in the accelerometer values or not.</p>
<p>Furthermore, this class features a <a href="qaccelerometer.html#reading">reading</a>() function that returns a <a href="qaccelerometerreading.html">QAccelerometerReading</a> instead of a <a href="qsensorreading.html">QSensorReading</a>.</p>
<p>For details about how the sensor works, see <a href="qaccelerometerreading.html">QAccelerometerReading</a>.</p>
</div>
<p><b>See also </b><a href="qaccelerometerreading.html">QAccelerometerReading</a>.</p>
<!-- @@@QAccelerometer -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$AccelerationMode$$$Combined$$$Gravity$$$User -->
<h3 class="fn" id="AccelerationMode-enum"><a name="AccelerationMode-enum"></a>enum QAccelerometer::<span class="name">AccelerationMode</span></h3>
<p>This enum represents the acceleration mode of an acceleration sensor.</p>
<p>The acceleration mode controls how the sensor reports acceleration. QAccelerometer::Combined is the only mode in which the values can be directly physically measured, the others are an approximation.</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>QAccelerometer::Combined</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">Both the acceleration caused by gravity and the acceleration caused by the user moving the device is reported combined.</td></tr>
<tr><td class="topAlign"><code>QAccelerometer::Gravity</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">Only the acceleration caused by gravity is reported. Movements of the device caused by the user have no effect other than changing the direction when the device is rotated.</td></tr>
<tr><td class="topAlign"><code>QAccelerometer::User</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">Only the acceleration caused by the user moving the device is reported, the effect of gravity is canceled out. A device at rest therefore should report values of, or close to, zero. In other APIs, this mode might be known as <i>linear acceleration</i>.</td></tr>
</table></div>
<p>This enum was introduced or modified in Qt 5.1.</p>
<p><b>See also </b><a href="qaccelerometer.html#accelerationMode-prop">QAccelerometer::accelerationMode</a>.</p>
<!-- @@@AccelerationMode -->
</div>
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$accelerationMode-prop$$$accelerationMode$$$setAccelerationModeAccelerationMode$$$accelerationModeChangedAccelerationMode -->
<h3 class="fn" id="accelerationMode-prop"><a name="accelerationMode-prop"></a><span class="name">accelerationMode</span> : <span class="type"><a href="qaccelerometer.html#AccelerationMode-enum">AccelerationMode</a></span></h3>
<p>This property holds the acceleration mode controls how acceleration values are reported.</p>
<p>The acceleration mode controls how the acceleration sensor reports its values. The default mode is <a href="qaccelerometer.html#AccelerationMode-enum">QAccelerometer::Combined</a>, which means the acceleration caused by gravity is included in the reported values.</p>
<p>Acceleration caused by gravity and acceleration caused by the user moving the device are physically impossible to distinguish because of general relativity. Most devices use sensor fusion to figure out which parts of the acceleration is caused by gravity, for example by using a rotation sensor to calculate the gravity direction and assuming a fixed magnitude for gravity. Therefore the result is only an approximation and may be inaccurate. The <a href="qaccelerometer.html#AccelerationMode-enum">QAccelerometer::Combined</a> mode is the most accurate one, as it does not involve approximating the gravity.</p>
<p>Not all backends and devices might support setting the acceleration mode. For those cases, the default mode <a href="qaccelerometer.html#AccelerationMode-enum">QAccelerometer::Combined</a> is used, changing it has no effect.</p>
<p>This property was introduced in Qt 5.1.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> AccelerationMode </td><td class="memItemRight bottomAlign"><span class="name"><b>accelerationMode</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qaccelerometer.html#setAccelerationMode">setAccelerationMode</a></b></span>(AccelerationMode <i>accelerationMode</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qaccelerometer.html#accelerationModeChanged">accelerationModeChanged</a></b></span>(AccelerationMode <i>accelerationMode</i>)</td></tr>
</table></div>
<!-- @@@accelerationMode -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QAccelerometer[overload1]$$$QAccelerometerQObject* -->
<h3 class="fn" id="QAccelerometer"><a name="QAccelerometer"></a>QAccelerometer::<span class="name">QAccelerometer</span>(<span class="type">QObject</span> *<i>parent</i> = Q_NULLPTR)</h3>
<p>Construct the sensor as a child of <i>parent</i>.</p>
<!-- @@@QAccelerometer -->
<!-- $$$~QAccelerometer[overload1]$$$~QAccelerometer -->
<h3 class="fn" id="dtor.QAccelerometer"><a name="dtor.QAccelerometer"></a><code>[virtual] </code>QAccelerometer::<span class="name">~QAccelerometer</span>()</h3>
<p>Destroy the sensor. Stops the sensor if it has not already been stopped.</p>
<!-- @@@~QAccelerometer -->
<!-- $$$accelerationModeChanged -->
<h3 class="fn" id="accelerationModeChanged"><a name="accelerationModeChanged"></a><code>[signal] </code><span class="type">void</span> QAccelerometer::<span class="name">accelerationModeChanged</span>(<span class="type"><a href="qaccelerometer.html#AccelerationMode-enum">AccelerationMode</a></span> <i>accelerationMode</i>)</h3>
<p>Emitted when the <i>accelerationMode</i> was changed.</p>
<p>This function was introduced in Qt 5.1.</p>
<p><b>Note:</b> Notifier signal for property <a href="qaccelerometer.html#accelerationMode-prop">accelerationMode</a>. </p><!-- @@@accelerationModeChanged -->
<!-- $$$reading[overload1]$$$reading -->
<h3 class="fn" id="reading"><a name="reading"></a><span class="type"><a href="qaccelerometerreading.html">QAccelerometerReading</a></span> *QAccelerometer::<span class="name">reading</span>() const</h3>
<p>Returns the reading class for this sensor.</p>
<p><b>See also </b><a href="qsensor.html#reading-prop">QSensor::reading</a>().</p>
<!-- @@@reading -->
<!-- $$$setAccelerationMode -->
<h3 class="fn" id="setAccelerationMode"><a name="setAccelerationMode"></a><span class="type">void</span> QAccelerometer::<span class="name">setAccelerationMode</span>(<span class="type"><a href="qaccelerometer.html#AccelerationMode-enum">AccelerationMode</a></span> <i>accelerationMode</i>)</h3>
<p>Sets the acceleration mode to <i>accelerationMode</i>.</p>
<p>This function was introduced in Qt 5.1.</p>
<p><b>Note:</b> Setter function for property <a href="qaccelerometer.html#accelerationMode-prop">accelerationMode</a>. </p><p><b>See also </b><a href="qaccelerometer.html#accelerationMode-prop">accelerationMode</a>().</p>
<!-- @@@setAccelerationMode -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2017 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
