<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qcompass.cpp -->
<title>QCompassReading 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 >QCompassReading</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="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
<li class="level2"><a href="#qcompassreading-units">QCompassReading Units</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QCompassReading Class</h1>
<!-- $$$QCompassReading-brief -->
<p>The <a href="qcompassreading.html">QCompassReading</a> class represents one reading from a compass. <a href="#details">More...</a></p>
<!-- @@@QCompassReading -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QCompassReading></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="qsensorreading.html">QSensorReading</a></td></tr></table></div><ul>
<li><a href="qcompassreading-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><a href="qcompassreading.html#azimuth-prop">azimuth</a></b> : const qreal</li>
<li class="fn"><b><a href="qcompassreading.html#calibrationLevel-prop">calibrationLevel</a></b> : const qreal</li>
</ul>
<ul>
<li class="fn">1 property inherited from <a href="qsensorreading.html#properties">QSensorReading</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"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qcompassreading.html#azimuth-prop">azimuth</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qcompassreading.html#calibrationLevel-prop">calibrationLevel</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcompassreading.html#setAzimuth">setAzimuth</a></b>(qreal <i>azimuth</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcompassreading.html#setCalibrationLevel">setCalibrationLevel</a></b>(qreal <i>calibrationLevel</i>)</td></tr>
</table></div>
<ul>
<li class="fn">4 public functions inherited from <a href="qsensorreading.html#public-functions">QSensorReading</a></li>
</ul>
<a name="details"></a>
<!-- $$$QCompassReading-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qcompassreading.html">QCompassReading</a> class represents one reading from a compass.</p>
<a name="qcompassreading-units"></a>
<h4 >QCompassReading Units</h4>
<p>The compass returns the azimuth of the device as degrees from magnetic north in a clockwise direction based on the top of the device, as defined by QScreen::nativeOrientation. There is also a value to indicate the calibration status of the device. If the device is not calibrated the azimuth may not be accurate.</p>
<p>Digital compasses are susceptible to magnetic interference and may need calibration after being placed near anything that emits a magnetic force. Accuracy of the compass can be affected by any ferrous materials that are nearby.</p>
<p>The calibration status of the device is measured as a number from 0 to 1. A value of 1 is the highest level that the device can support and 0 is the worst.</p>
</div>
<!-- @@@QCompassReading -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$azimuth-prop$$$azimuth -->
<h3 class="fn" id="azimuth-prop"><a name="azimuth-prop"></a><span class="name">azimuth</span> : const <span class="type">qreal</span></h3>
<p>This property holds the azimuth of the device.</p>
<p>Measured in degrees from magnetic north in a clockwise direction based on the top of the device, as defined by QPlatformScreen::nativeOrientation.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> qreal </td><td class="memItemRight bottomAlign"><span class="name"><b>azimuth</b></span>() const</td></tr>
</table></div>
<p><b>See also </b><a href="qcompassreading.html#qcompassreading-units">QCompassReading Units</a>.</p>
<!-- @@@azimuth -->
<!-- $$$calibrationLevel-prop$$$calibrationLevel -->
<h3 class="fn" id="calibrationLevel-prop"><a name="calibrationLevel-prop"></a><span class="name">calibrationLevel</span> : const <span class="type">qreal</span></h3>
<p>This property holds the calibration level of the reading.</p>
<p>Measured as a value from 0 to 1 with higher values being better.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> qreal </td><td class="memItemRight bottomAlign"><span class="name"><b>calibrationLevel</b></span>() const</td></tr>
</table></div>
<p><b>See also </b><a href="qcompassreading.html#qcompassreading-units">QCompassReading Units</a>.</p>
<!-- @@@calibrationLevel -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$setAzimuth[overload1]$$$setAzimuthqreal -->
<h3 class="fn" id="setAzimuth"><a name="setAzimuth"></a><span class="type">void</span> QCompassReading::<span class="name">setAzimuth</span>(<span class="type">qreal</span> <i>azimuth</i>)</h3>
<p>Sets the <i>azimuth</i> of the device.</p>
<p><b>See also </b><a href="qcompassreading.html#azimuth-prop">azimuth</a>() and <a href="qcompassreading.html#qcompassreading-units">QCompassReading Units</a>.</p>
<!-- @@@setAzimuth -->
<!-- $$$setCalibrationLevel[overload1]$$$setCalibrationLevelqreal -->
<h3 class="fn" id="setCalibrationLevel"><a name="setCalibrationLevel"></a><span class="type">void</span> QCompassReading::<span class="name">setCalibrationLevel</span>(<span class="type">qreal</span> <i>calibrationLevel</i>)</h3>
<p>Sets the calibration level of the reading to <i>calibrationLevel</i>.</p>
<p><b>See also </b><a href="qcompassreading.html#calibrationLevel-prop">calibrationLevel</a>().</p>
<!-- @@@setCalibrationLevel -->
</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>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
aa084d0e0126d94ee0fb846ebdf50e37
>
files
>
81
