<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qcamerafocus.cpp -->
<title>QCameraFocusZone Class | Qt Multimedia 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="qtmultimedia-index.html">Qt Multimedia</a></td><td ><a href="qtmultimedia-modules.html">C++ Classes</a></td><td >QCameraFocusZone</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="#public-functions">Public Functions</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">QCameraFocusZone Class</h1>
<!-- $$$QCameraFocusZone-brief -->
<p>The <a href="qcamerafocuszone.html">QCameraFocusZone</a> class provides information on zones used for autofocusing a camera. <a href="#details">More...</a></p>
<!-- @@@QCameraFocusZone -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QCameraFocusZone></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += multimedia</td></tr></table></div><ul>
<li><a href="qcamerafocuszone-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="qcamerafocuszone.html#FocusZoneStatus-enum">FocusZoneStatus</a></b> { Invalid, Unused, Selected, Focused }</td></tr>
</table></div>
<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="qcamerafocuszone.html#QCameraFocusZone">QCameraFocusZone</a></b>(const QCameraFocusZone &<i>other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcamerafocuszone.html#dtor.QCameraFocusZone">~QCameraFocusZone</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QRectF </td><td class="memItemRight bottomAlign"><b><a href="qcamerafocuszone.html#area">area</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcamerafocuszone.html#isValid">isValid</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> FocusZoneStatus </td><td class="memItemRight bottomAlign"><b><a href="qcamerafocuszone.html#status">status</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcamerafocuszone.html#operator-not-eq">operator!=</a></b>(const QCameraFocusZone &<i>other</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QCameraFocusZone &</td><td class="memItemRight bottomAlign"><b><a href="qcamerafocuszone.html#operator-eq">operator=</a></b>(const QCameraFocusZone &<i>other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcamerafocuszone.html#operator-eq-eq">operator==</a></b>(const QCameraFocusZone &<i>other</i>) const</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QCameraFocusZone-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qcamerafocuszone.html">QCameraFocusZone</a> class provides information on zones used for autofocusing a camera.</p>
<p>For cameras that support autofocusing, in order for a camera to autofocus on part of a sensor frame, it considers different zones within the frame. Which zones to use, and where the zones are located vary between different cameras.</p>
<p>This class exposes what zones are used by a particular camera, and a list of the zones can be retrieved by a <a href="qcamerafocus.html">QCameraFocus</a> instance.</p>
<p>You can use this information to present visual feedback - for example, drawing rectangles around areas of the camera frame that are in focus, or changing the color of a zone as it comes into focus.</p>
<pre class="cpp">
focus<span class="operator">-</span><span class="operator">></span>setFocusPointMode(<span class="type"><a href="qcamerafocus.html">QCameraFocus</a></span><span class="operator">::</span>FocusPointAuto);
<span class="type">QList</span><span class="operator"><</span><span class="type"><a href="qcamerafocuszone.html#QCameraFocusZone">QCameraFocusZone</a></span><span class="operator">></span> zones <span class="operator">=</span> focus<span class="operator">-</span><span class="operator">></span>focusZones();
foreach (<span class="type"><a href="qcamerafocuszone.html#QCameraFocusZone">QCameraFocusZone</a></span> zone<span class="operator">,</span> zones) {
<span class="keyword">if</span> (zone<span class="operator">.</span>status() <span class="operator">=</span><span class="operator">=</span> <span class="type"><a href="qcamerafocuszone.html#QCameraFocusZone">QCameraFocusZone</a></span><span class="operator">::</span>Focused) {
<span class="comment">// Draw a green box at zone.area()</span>
} <span class="keyword">else</span> <span class="keyword">if</span> (zone<span class="operator">.</span>status() <span class="operator">=</span><span class="operator">=</span> <span class="type"><a href="qcamerafocuszone.html#QCameraFocusZone">QCameraFocusZone</a></span><span class="operator">::</span>Selected) {
<span class="comment">// This area is selected for autofocusing, but is not in focus</span>
<span class="comment">// Draw a yellow box at zone.area()</span>
}
}
</pre>
</div>
<p><b>See also </b><a href="qcamerafocus.html">QCameraFocus</a>.</p>
<!-- @@@QCameraFocusZone -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$FocusZoneStatus$$$Invalid$$$Unused$$$Selected$$$Focused -->
<h3 class="fn" id="FocusZoneStatus-enum"><a name="FocusZoneStatus-enum"></a>enum QCameraFocusZone::<span class="name">FocusZoneStatus</span></h3>
<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>QCameraFocusZone::Invalid</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">This zone is not valid</td></tr>
<tr><td class="topAlign"><code>QCameraFocusZone::Unused</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">This zone may be used for autofocusing, but is not currently.</td></tr>
<tr><td class="topAlign"><code>QCameraFocusZone::Selected</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">This zone is currently being used for autofocusing, but is not in focus.</td></tr>
<tr><td class="topAlign"><code>QCameraFocusZone::Focused</code></td><td class="topAlign tblval"><code>3</code></td><td class="topAlign">This zone is being used for autofocusing and is currently in focus.</td></tr>
</table></div>
<!-- @@@FocusZoneStatus -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QCameraFocusZone[overload1]$$$QCameraFocusZoneconstQCameraFocusZone& -->
<h3 class="fn" id="QCameraFocusZone"><a name="QCameraFocusZone"></a>QCameraFocusZone::<span class="name">QCameraFocusZone</span>(const <span class="type"><a href="qcamerafocuszone.html#QCameraFocusZone">QCameraFocusZone</a></span> &<i>other</i>)</h3>
<p>Creates a new <a href="qcamerafocuszone.html">QCameraFocusZone</a> as a copy of <i>other</i>.</p>
<!-- @@@QCameraFocusZone -->
<!-- $$$~QCameraFocusZone[overload1]$$$~QCameraFocusZone -->
<h3 class="fn" id="dtor.QCameraFocusZone"><a name="dtor.QCameraFocusZone"></a>QCameraFocusZone::<span class="name">~QCameraFocusZone</span>()</h3>
<p>Destroys this <a href="qcamerafocuszone.html">QCameraFocusZone</a>.</p>
<!-- @@@~QCameraFocusZone -->
<!-- $$$area[overload1]$$$area -->
<h3 class="fn" id="area"><a name="area"></a><span class="type">QRectF</span> QCameraFocusZone::<span class="name">area</span>() const</h3>
<p>Returns the area of the camera frame that this focus zone encompasses.</p>
<p>Coordinates are in frame relative coordinates - <code>QPointF(0,0)</code> is the top left of the frame, and <code>QPointF(1,1)</code> is the bottom right.</p>
<!-- @@@area -->
<!-- $$$isValid[overload1]$$$isValid -->
<h3 class="fn" id="isValid"><a name="isValid"></a><span class="type">bool</span> QCameraFocusZone::<span class="name">isValid</span>() const</h3>
<p>Returns true if this focus zone has a valid area and status.</p>
<!-- @@@isValid -->
<!-- $$$status[overload1]$$$status -->
<h3 class="fn" id="status"><a name="status"></a><span class="type"><a href="qcamerafocuszone.html#FocusZoneStatus-enum">FocusZoneStatus</a></span> QCameraFocusZone::<span class="name">status</span>() const</h3>
<p>Returns the current status of this focus zone.</p>
<!-- @@@status -->
<!-- $$$operator!=[overload1]$$$operator!=constQCameraFocusZone& -->
<h3 class="fn" id="operator-not-eq"><a name="operator-not-eq"></a><span class="type">bool</span> QCameraFocusZone::<span class="name">operator!=</span>(const <span class="type"><a href="qcamerafocuszone.html#QCameraFocusZone">QCameraFocusZone</a></span> &<i>other</i>) const</h3>
<p>Returns true if this focus zone is not the same as <i>other</i>.</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQCameraFocusZone& -->
<h3 class="fn" id="operator-eq"><a name="operator-eq"></a><span class="type"><a href="qcamerafocuszone.html#QCameraFocusZone">QCameraFocusZone</a></span> &QCameraFocusZone::<span class="name">operator=</span>(const <span class="type"><a href="qcamerafocuszone.html#QCameraFocusZone">QCameraFocusZone</a></span> &<i>other</i>)</h3>
<p>Assigns <i>other</i> to this <a href="qcamerafocuszone.html">QCameraFocusZone</a>.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQCameraFocusZone& -->
<h3 class="fn" id="operator-eq-eq"><a name="operator-eq-eq"></a><span class="type">bool</span> QCameraFocusZone::<span class="name">operator==</span>(const <span class="type"><a href="qcamerafocuszone.html#QCameraFocusZone">QCameraFocusZone</a></span> &<i>other</i>) const</h3>
<p>Returns true if this focus zone is the same as <i>other</i>.</p>
<!-- @@@operator== -->
</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>
