<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- locationsingleton.cpp -->
<title>QtPositioning QML 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 >QtPositioning QML 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="#methods">Methods</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">QtPositioning QML Type</h1>
<span class="subtitle"></span>
<!-- $$$QtPositioning-brief -->
<p>The <a href="qtpositioning-module.html">QtPositioning</a> global object provides useful functions for working with location-based types in QML. <a href="#details">More...</a></p>
<!-- @@@QtPositioning -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtPositioning 5.12</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.2</td></tr></table></div><ul>
<li><a href="qml-qtpositioning-qtpositioning-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="methods"></a>
<h2 id="methods">Methods</h2>
<ul>
<li class="fn">geocircle <b><b><a href="qml-qtpositioning-qtpositioning.html#circle-method">circle</a></b></b>()</li>
<li class="fn">geocircle <b><b><a href="qml-qtpositioning-qtpositioning.html#circle-method-1">circle</a></b></b>(coordinate <i>center</i>, real <i>radius</i>)</li>
<li class="fn">point <b><b><a href="qml-qtpositioning-qtpositioning.html#coordToMercator-method">coordToMercator</a></b></b>(coordinate <i>coord</i>)</li>
<li class="fn">coordinate <b><b><a href="qml-qtpositioning-qtpositioning.html#coordinate-method">coordinate</a></b></b>()</li>
<li class="fn">coordinate <b><b><a href="qml-qtpositioning-qtpositioning.html#coordinate-method-1">coordinate</a></b></b>(real <i>latitude</i>, real <i>longitue</i>, real <i>altitude</i>)</li>
<li class="fn">coordinate <b><b><a href="qml-qtpositioning-qtpositioning.html#mercatorToCoord-method">mercatorToCoord</a></b></b>(point <i>mercator</i>)</li>
<li class="fn">geopath <b><b><a href="qml-qtpositioning-qtpositioning.html#path-method">path</a></b></b>()</li>
<li class="fn">geopolygon <b><b><a href="qml-qtpositioning-qtpositioning.html#polygon-method">polygon</a></b></b>()</li>
<li class="fn">geopolygon <b><b><a href="qml-qtpositioning-qtpositioning.html#polygon-method-1">polygon</a></b></b>(list<coordinate> <i>coordinates</i>)</li>
<li class="fn">geopolygon <b><b><a href="qml-qtpositioning-qtpositioning.html#polygon-method-2">polygon</a></b></b>(list<coordinate> <i>perimeter</i>, list<list<coordinate>> <i>holes</i>)</li>
<li class="fn">georectangle <b><b><a href="qml-qtpositioning-qtpositioning.html#rectangle-method">rectangle</a></b></b>()</li>
<li class="fn">georectangle <b><b><a href="qml-qtpositioning-qtpositioning.html#rectangle-method-1">rectangle</a></b></b>(coordinate <i>center</i>, real <i>width</i>, real <i>height</i>)</li>
<li class="fn">georectangle <b><b><a href="qml-qtpositioning-qtpositioning.html#rectangle-method-2">rectangle</a></b></b>(coordinate <i>topLeft</i>, coordinate <i>bottomRight</i>)</li>
<li class="fn">geoshape <b><b><a href="qml-qtpositioning-qtpositioning.html#shape-method">shape</a></b></b>()</li>
<li class="fn">geocircle <b><b><a href="qml-qtpositioning-qtpositioning.html#shapeToCircle-method">shapeToCircle</a></b></b>(geoshape <i>shape</i>)</li>
<li class="fn">geopath <b><b><a href="qml-qtpositioning-qtpositioning.html#shapeToPath-method">shapeToPath</a></b></b>(geoshape <i>shape</i>)</li>
<li class="fn">geopolygon <b><b><a href="qml-qtpositioning-qtpositioning.html#shapeToPolygon-method">shapeToPolygon</a></b></b>(geoshape <i>shape</i>)</li>
<li class="fn">georectangle <b><b><a href="qml-qtpositioning-qtpositioning.html#shapeToRectangle-method">shapeToRectangle</a></b></b>(geoshape <i>shape</i>)</li>
</ul>
<!-- $$$QtPositioning-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<pre class="qml">
</pre>
<!-- @@@QtPositioning -->
<h2>Method Documentation</h2>
<!-- $$$circle -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="circle-method">
<td class="tblQmlFuncNode"><p>
<a name="circle-method"></a><span class="type"><a href="qml-geocircle.html">geocircle</a></span> <span class="name">circle</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Constructs an invalid geocircle.</p>
<p><b>See also </b><a href="qml-geocircle.html">geocircle</a>.</p>
</div></div><!-- @@@circle -->
<br/>
<!-- $$$circle -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="circle-method-1">
<td class="tblQmlFuncNode"><p>
<a name="circle-method-1"></a><span class="type"><a href="qml-geocircle.html">geocircle</a></span> <span class="name">circle</span>(<span class="type"><a href="qml-qtpositioning-qtpositioning.html#coordinate-method">coordinate</a></span> <i>center</i>, <span class="type">real</span> <i>radius</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Constructs a geocircle centered at <i>center</i> with a radius of <i>radius</i> meters.</p>
</div></div><!-- @@@circle -->
<br/>
<!-- $$$coordToMercator -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="coordToMercator-method">
<td class="tblQmlFuncNode"><p>
<a name="coordToMercator-method"></a><span class="type">point</span> <span class="name">coordToMercator</span>(<span class="type"><a href="qml-qtpositioning-qtpositioning.html#coordinate-method">coordinate</a></span> <i>coord</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Converts a coordinate into a mercator coordinate.</p>
<p>This method was introduced in Qt 5.12.</p>
<p><b>See also </b><a href="qml-qtpositioning-qtpositioning.html#mercatorToCoord-method">mercatorToCoord</a>.</p>
</div></div><!-- @@@coordToMercator -->
<br/>
<!-- $$$coordinate -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="coordinate-method">
<td class="tblQmlFuncNode"><p>
<a name="coordinate-method"></a><span class="type"><a href="qml-qtpositioning-qtpositioning.html#coordinate-method">coordinate</a></span> <span class="name">coordinate</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Constructs an invalid coordinate.</p>
</div></div><!-- @@@coordinate -->
<br/>
<!-- $$$coordinate -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="coordinate-method-1">
<td class="tblQmlFuncNode"><p>
<a name="coordinate-method-1"></a><span class="type"><a href="qml-qtpositioning-qtpositioning.html#coordinate-method">coordinate</a></span> <span class="name">coordinate</span>(<span class="type">real</span> <i>latitude</i>, <span class="type">real</span> <i>longitue</i>, <span class="type">real</span> <i>altitude</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Constructs a coordinate with the specified <i>latitude</i>, <i>longitude</i> and optional <i>altitude</i>. Both <i>latitude</i> and <i>longitude</i> must be valid, otherwise an invalid coordinate is returned.</p>
<p><b>See also </b><a href="qml-qtpositioning-qtpositioning.html#coordinate-method">coordinate</a>.</p>
</div></div><!-- @@@coordinate -->
<br/>
<!-- $$$mercatorToCoord -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="mercatorToCoord-method">
<td class="tblQmlFuncNode"><p>
<a name="mercatorToCoord-method"></a><span class="type"><a href="qml-qtpositioning-qtpositioning.html#coordinate-method">coordinate</a></span> <span class="name">mercatorToCoord</span>(<span class="type">point</span> <i>mercator</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Converts a mercator coordinate into a latitude-longitude coordinate.</p>
<p>This method was introduced in Qt 5.12.</p>
<p><b>See also </b><a href="qml-qtpositioning-qtpositioning.html#coordToMercator-method">coordToMercator</a>.</p>
</div></div><!-- @@@mercatorToCoord -->
<br/>
<!-- $$$path -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="path-method">
<td class="tblQmlFuncNode"><p>
<a name="path-method"></a><span class="type"><a href="qml-geopath.html">geopath</a></span> <span class="name">path</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Constructs an empty geopath.</p>
<p>This method was introduced in Qt 5.9.</p>
<p><b>See also </b><a href="qml-geopath.html">geopath</a>.</p>
</div></div><!-- @@@path -->
<br/>
<!-- $$$polygon -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="polygon-method">
<td class="tblQmlFuncNode"><p>
<a name="polygon-method"></a><span class="type"><a href="qml-geopolygon.html">geopolygon</a></span> <span class="name">polygon</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Constructs an empty polygon.</p>
<p>This method was introduced in Qt 5.10.</p>
<p><b>See also </b><a href="qml-geopolygon.html">geopolygon</a>.</p>
</div></div><!-- @@@polygon -->
<br/>
<!-- $$$polygon -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="polygon-method-1">
<td class="tblQmlFuncNode"><p>
<a name="polygon-method-1"></a><span class="type"><a href="qml-geopolygon.html">geopolygon</a></span> <span class="name">polygon</span>(<span class="type">list</span><<span class="type"><a href="qml-qtpositioning-qtpositioning.html#coordinate-method">coordinate</a></span>> <i>coordinates</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Constructs a polygon from coordinates.</p>
<p>This method was introduced in Qt 5.10.</p>
<p><b>See also </b><a href="qml-geopolygon.html">geopolygon</a>.</p>
</div></div><!-- @@@polygon -->
<br/>
<!-- $$$polygon -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="polygon-method-2">
<td class="tblQmlFuncNode"><p>
<a name="polygon-method-2"></a><span class="type"><a href="qml-geopolygon.html">geopolygon</a></span> <span class="name">polygon</span>(<span class="type">list</span><<span class="type"><a href="qml-qtpositioning-qtpositioning.html#coordinate-method">coordinate</a></span>> <i>perimeter</i>, <span class="type">list</span><<span class="type">list</span><<span class="type"><a href="qml-qtpositioning-qtpositioning.html#coordinate-method">coordinate</a></span>>> <i>holes</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Constructs a polygon from coordinates for perimeter and inner holes.</p>
<p>This method was introduced in Qt 5.12.</p>
<p><b>See also </b><a href="qml-geopolygon.html">geopolygon</a>.</p>
</div></div><!-- @@@polygon -->
<br/>
<!-- $$$rectangle -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="rectangle-method">
<td class="tblQmlFuncNode"><p>
<a name="rectangle-method"></a><span class="type"><a href="qml-georectangle.html">georectangle</a></span> <span class="name">rectangle</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Constructs an invalid georectangle.</p>
<p><b>See also </b><a href="qml-georectangle.html">georectangle</a>.</p>
</div></div><!-- @@@rectangle -->
<br/>
<!-- $$$rectangle -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="rectangle-method-1">
<td class="tblQmlFuncNode"><p>
<a name="rectangle-method-1"></a><span class="type"><a href="qml-georectangle.html">georectangle</a></span> <span class="name">rectangle</span>(<span class="type"><a href="qml-qtpositioning-qtpositioning.html#coordinate-method">coordinate</a></span> <i>center</i>, <span class="type">real</span> <i>width</i>, <span class="type">real</span> <i>height</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Constructs a georectangle centered at <i>center</i> with a width of <i>width</i> degrees and a hight of <i>height</i> degrees.</p>
<p><b>See also </b><a href="qml-georectangle.html">georectangle</a>.</p>
</div></div><!-- @@@rectangle -->
<br/>
<!-- $$$rectangle -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="rectangle-method-2">
<td class="tblQmlFuncNode"><p>
<a name="rectangle-method-2"></a><span class="type"><a href="qml-georectangle.html">georectangle</a></span> <span class="name">rectangle</span>(<span class="type"><a href="qml-qtpositioning-qtpositioning.html#coordinate-method">coordinate</a></span> <i>topLeft</i>, <span class="type"><a href="qml-qtpositioning-qtpositioning.html#coordinate-method">coordinate</a></span> <i>bottomRight</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Constructs a georectangle with its top left corner positioned at <i>topLeft</i> and its bottom right corner positioned at <i>bottomLeft</i>.</p>
<p><b>See also </b><a href="qml-georectangle.html">georectangle</a>.</p>
</div></div><!-- @@@rectangle -->
<br/>
<!-- $$$shape -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="shape-method">
<td class="tblQmlFuncNode"><p>
<a name="shape-method"></a><span class="type"><a href="qml-geoshape.html">geoshape</a></span> <span class="name">shape</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Constructs an invalid geoshape.</p>
<p><b>See also </b><a href="qml-geoshape.html">geoshape</a>.</p>
</div></div><!-- @@@shape -->
<br/>
<!-- $$$shapeToCircle -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="shapeToCircle-method">
<td class="tblQmlFuncNode"><p>
<a name="shapeToCircle-method"></a><span class="type"><a href="qml-geocircle.html">geocircle</a></span> <span class="name">shapeToCircle</span>(<span class="type"><a href="qml-geoshape.html">geoshape</a></span> <i>shape</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Converts <i>shape</i> to a geocircle.</p>
<p>This method was introduced in Qt 5.5.</p>
<p><b>See also </b><a href="qml-geocircle.html">geocircle</a>.</p>
</div></div><!-- @@@shapeToCircle -->
<br/>
<!-- $$$shapeToPath -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="shapeToPath-method">
<td class="tblQmlFuncNode"><p>
<a name="shapeToPath-method"></a><span class="type"><a href="qml-geopath.html">geopath</a></span> <span class="name">shapeToPath</span>(<span class="type"><a href="qml-geoshape.html">geoshape</a></span> <i>shape</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Converts <i>shape</i> to a geopath.</p>
<p>This method was introduced in Qt 5.9.</p>
<p><b>See also </b><a href="qml-geopath.html">geopath</a>.</p>
</div></div><!-- @@@shapeToPath -->
<br/>
<!-- $$$shapeToPolygon -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="shapeToPolygon-method">
<td class="tblQmlFuncNode"><p>
<a name="shapeToPolygon-method"></a><span class="type"><a href="qml-geopolygon.html">geopolygon</a></span> <span class="name">shapeToPolygon</span>(<span class="type"><a href="qml-geoshape.html">geoshape</a></span> <i>shape</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Converts <i>shape</i> to a polygon.</p>
<p>This method was introduced in Qt 5.10.</p>
<p><b>See also </b><a href="qml-geopolygon.html">geopolygon</a>.</p>
</div></div><!-- @@@shapeToPolygon -->
<br/>
<!-- $$$shapeToRectangle -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="shapeToRectangle-method">
<td class="tblQmlFuncNode"><p>
<a name="shapeToRectangle-method"></a><span class="type"><a href="qml-georectangle.html">georectangle</a></span> <span class="name">shapeToRectangle</span>(<span class="type"><a href="qml-geoshape.html">geoshape</a></span> <i>shape</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Converts <i>shape</i> to a georectangle.</p>
<p>This method was introduced in Qt 5.5.</p>
<p><b>See also </b><a href="qml-georectangle.html">georectangle</a>.</p>
</div></div><!-- @@@shapeToRectangle -->
<br/>
</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>
