<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- positioning.cpp -->
<title>georectangle QML Basic Type | Qt Positioning 5.12.6</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.12</td><td ><a href="qtpositioning-index.html">Qt Positioning</a></td><td ><a href="qtpositioning-qmlmodule.html">QML Types</a></td><td >georectangle QML Basic Type</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtpositioning-index.html">Qt 5.12.6 Reference Documentation</a></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="#limitations">Limitations</a></li>
<li class="level1"><a href="#example-usage">Example Usage</a></li>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level2"><a href="#bottomleft">bottomLeft</a></li>
<li class="level2"><a href="#bottomright">bottomRight</a></li>
<li class="level2"><a href="#center">center</a></li>
<li class="level2"><a href="#height">height</a></li>
<li class="level2"><a href="#topleft">topLeft</a></li>
<li class="level2"><a href="#topright">topRight</a></li>
<li class="level2"><a href="#width">width</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">georectangle QML Basic Type</h1>
<span class="subtitle"></span>
<!-- $$$georectangle-description -->
<div class="descr"> <a name="details"></a>
<p>The georectangle type represents a rectangular geographic area.</p>
<p>The <code>georectangle</code> type is a <a href="qml-geoshape.html">geoshape</a> that represents a rectangular geographic area. The type is direct representation of a <a href="qgeorectangle.html">QGeoRectangle</a>. It is defined by a pair of <a href="qml-coordinate.html">coordinates</a> which represent the top-left and bottom-right corners of the <code>georectangle</code>. The coordinates are accessible from the <a href="qml-georectangle.html#topleft">topLeft</a> and <a href="qml-georectangle.html#bottomright">bottomRight</a> attributes.</p>
<p>A <code>georectangle</code> is considered invalid if the top-left or bottom-right coordinates are invalid or if the top-left coordinate is south of the bottom-right coordinate.</p>
<p>The coordinates of the four corners of the <code>georectangle</code> can be accessed with the <a href="qml-georectangle.html#topleft">topLeft</a>, <a href="qml-georectangle.html#topright">topRight</a>, <a href="qml-georectangle.html#bottomleft">bottomLeft</a> and <a href="qml-georectangle.html#bottomright">bottomRight</a> attributes. The <a href="qml-geocircle.html#center">center</a> attribute can be used to get the coordinate of the center of the <code>georectangle</code>. The <a href="qml-geopath.html#width">width</a> and <a href="qml-georectangle.html#height">height</a> attributes can be used to get the width and height of the <code>georectangle</code> in degrees. Setting one of these attributes will cause the other attributes to be adjusted accordingly.</p>
<a name="limitations"></a>
<h2 id="limitations">Limitations</h2>
<p>A <code>georectangle</code> can never cross the poles.</p>
<p>If the height or center of a <code>georectangle</code> is adjusted such that it would cross one of the poles the height is modified such that the <code>georectangle</code> touches but does not cross the pole and that the center coordinate is still in the center of the <code>georectangle</code>.</p>
<a name="example-usage"></a>
<h2 id="example-usage">Example Usage</h2>
<p>Use properties of type variant to store a <code>georectangle</code>. To create a <code>georectangle</code> value, use the <a href="qml-qtpositioning-qtpositioning.html#rectangle-method">QtPositioning.rectangle()</a> function:</p>
<pre class="qml">
</pre>
<p>When integrating with C++, note that any <a href="qgeorectangle.html">QGeoRectangle</a> value passed into QML from C++ is automatically converted into a <code>georectangle</code> value, and vice-versa.</p>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<a name="bottomleft"></a>
<h3 id="bottomleft">bottomLeft</h3>
<pre class="cpp">
coordinate bottomLeft
</pre>
<p>This property holds the bottom left coordinate of this georectangle.</p>
<a name="bottomright"></a>
<h3 id="bottomright">bottomRight</h3>
<pre class="cpp">
coordinate bottomRight
</pre>
<p>This property holds the bottom right coordinate of this georectangle.</p>
<a name="center"></a>
<h3 id="center">center</h3>
<pre class="cpp">
coordinate center
</pre>
<p>This property holds the center coordinate of this georectangle. For more details see <a href="qgeorectangle.html#setCenter">QGeoRectangle::setCenter()</a>.</p>
<a name="height"></a>
<h3 id="height">height</h3>
<pre class="cpp">
<span class="type">double</span> height
</pre>
<p>This property holds the height of this georectangle (in degrees). For more details see <a href="qgeorectangle.html#setHeight">QGeoRectangle::setHeight()</a>.</p>
<p><b>Note: </b>If the georectangle is invalid, it is not possible to set the height. <a href="qtpositioning-module.html">QtPositioning</a> releases prior to Qt 5.5 permitted the setting of the height even on invalid georectangles.</p><a name="topleft"></a>
<h3 id="topleft">topLeft</h3>
<pre class="cpp">
coordinate topLeft
</pre>
<p>This property holds the top left coordinate of this georectangle.</p>
<a name="topright"></a>
<h3 id="topright">topRight</h3>
<pre class="cpp">
coordinate topRight
</pre>
<p>This property holds the top right coordinate of this georectangle.</p>
<a name="width"></a>
<h3 id="width">width</h3>
<pre class="cpp">
<span class="type">double</span> width
</pre>
<p>This property holds the width of this georectangle (in degrees). For more details see <a href="qgeorectangle.html#setWidth">QGeoRectangle::setWidth()</a>.</p>
<p><b>Note: </b>If the georectangle is invalid, it is not possible to set the width. <a href="qtpositioning-module.html">QtPositioning</a> releases prior to Qt 5.5 permitted the setting of the width even on invalid georectangles.</p></div>
<!-- @@@georectangle -->
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2019 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>
