Sophie

Sophie

distrib > Mageia > 6 > x86_64 > media > core-updates > by-pkgid > ed56237261fa5ad3d1f8082a5fac7e2e > files > 132

qtlocation5-doc-5.9.4-1.mga6.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qdeclarativegeomaneuver.cpp -->
  <title>RouteManeuver QML Type | Qt Location 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="qtlocation-index.html">Qt Location</a></td><td ><a href="qtlocation-qmlmodule.html">QML Types</a></td><td >RouteManeuver QML Type</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="#details">Detailed Description</a></li>
<li class="level2"><a href="#example">Example</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">RouteManeuver QML Type</h1>
<span class="subtitle"></span>
<!-- $$$RouteManeuver-brief -->
<p>The <a href="qml-qtlocation-routemaneuver.html">RouteManeuver</a> type represents the information relevant to the point at which two RouteSegments meet. <a href="#details">More...</a></p>
<!-- @@@RouteManeuver -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtLocation 5.3</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign">  Qt Location 5.5</td></tr></table></div><ul>
<li><a href="qml-qtlocation-routemaneuver-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><b><a href="qml-qtlocation-routemaneuver.html#direction-prop">direction</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-qtlocation-routemaneuver.html#distanceToNextInstruction-prop">distanceToNextInstruction</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtlocation-routemaneuver.html#instructionText-prop">instructionText</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtlocation-routemaneuver.html#position-prop">position</a></b></b> : coordinate</li>
<li class="fn"><b><b><a href="qml-qtlocation-routemaneuver.html#timeToNextInstruction-prop">timeToNextInstruction</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtlocation-routemaneuver.html#valid-prop">valid</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtlocation-routemaneuver.html#waypoint-prop">waypoint</a></b></b> : coordinate</li>
<li class="fn"><b><b><a href="qml-qtlocation-routemaneuver.html#waypointValid-prop">waypointValid</a></b></b> : bool</li>
</ul>
<!-- $$$RouteManeuver-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p><a href="qml-qtlocation-routesegment.html">RouteSegment</a> instances can be thought of as edges on a routing graph, with <a href="qml-qtlocation-routemaneuver.html">RouteManeuver</a> instances as optional labels attached to the vertices of the graph.</p>
<p>The most interesting information held in a <a href="qml-qtlocation-routemaneuver.html">RouteManeuver</a> instance is normally the textual navigation to provide and the position at which to provide it, accessible by <a href="qml-qtlocation-routemaneuver.html#instructionText-prop">instructionText</a> and <a href="qml-qtlocation-routemaneuver.html#position-prop">position</a> respectively.</p>
<a name="example"></a>
<h2 id="example">Example</h2>
<p>The following QML snippet demonstrates how to print information about a route maneuver:</p>
<pre class="qml">

  import QtQuick 2.3
  import QtPositioning 5.5
  import QtLocation 5.6

  <span class="type">Text</span> {
      <span class="name">text</span>: <span class="string">&quot;Distance till next maneuver: &quot;</span> <span class="operator">+</span> <span class="name">routeManeuver</span>.<span class="name">distanceToNextInstruction</span>
            <span class="operator">+</span> <span class="string">&quot; meters, estimated time: &quot;</span> <span class="operator">+</span> <span class="name">routeManeuver</span>.<span class="name">timeToNextInstruction</span> <span class="operator">+</span> <span class="string">&quot; seconds.&quot;</span>
  }

</pre>
<!-- @@@RouteManeuver -->
<h2>Property Documentation</h2>
<!-- $$$direction -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="direction-prop">
<td class="tblQmlPropNode"><p>
<a name="direction-prop"></a><span class="name">direction</span> : <span class="type">enumeration</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Describes the change in direction associated with the instruction text that is associated with a <a href="qml-qtlocation-routemaneuver.html">RouteManeuver</a>.</p>
<ul>
<li><a href="qml-qtlocation-routemaneuver.html">RouteManeuver</a>.NoDirection - There is no direction associated with the instruction text</li>
<li><a href="qml-qtlocation-routemaneuver.html">RouteManeuver</a>.DirectionForward - The instruction indicates that the direction of travel does not need to change</li>
<li><a href="qml-qtlocation-routemaneuver.html">RouteManeuver</a>.DirectionBearRight - The instruction indicates that the direction of travel should bear to the right</li>
<li><a href="qml-qtlocation-routemaneuver.html">RouteManeuver</a>.DirectionLightRight - The instruction indicates that a light turn to the right is required</li>
<li><a href="qml-qtlocation-routemaneuver.html">RouteManeuver</a>.DirectionRight - The instruction indicates that a turn to the right is required</li>
<li><a href="qml-qtlocation-routemaneuver.html">RouteManeuver</a>.DirectionHardRight - The instruction indicates that a hard turn to the right is required</li>
<li><a href="qml-qtlocation-routemaneuver.html">RouteManeuver</a>.DirectionUTurnRight - The instruction indicates that a u-turn to the right is required</li>
<li><a href="qml-qtlocation-routemaneuver.html">RouteManeuver</a>.DirectionUTurnLeft - The instruction indicates that a u-turn to the left is required</li>
<li><a href="qml-qtlocation-routemaneuver.html">RouteManeuver</a>.DirectionHardLeft - The instruction indicates that a hard turn to the left is required</li>
<li><a href="qml-qtlocation-routemaneuver.html">RouteManeuver</a>.DirectionLeft - The instruction indicates that a turn to the left is required</li>
<li><a href="qml-qtlocation-routemaneuver.html">RouteManeuver</a>.DirectionLightLeft - The instruction indicates that a light turn to the left is required</li>
<li><a href="qml-qtlocation-routemaneuver.html">RouteManeuver</a>.DirectionBearLeft - The instruction indicates that the direction of travel should bear to the left</li>
</ul>
</div></div><!-- @@@direction -->
<br/>
<!-- $$$distanceToNextInstruction -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="distanceToNextInstruction-prop">
<td class="tblQmlPropNode"><p>
<a name="distanceToNextInstruction-prop"></a><span class="name">distanceToNextInstruction</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This read-only property holds the distance, in meters, between the point at which the associated instruction was issued and the point that the next instruction should be issued.</p>
</div></div><!-- @@@distanceToNextInstruction -->
<br/>
<!-- $$$instructionText -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="instructionText-prop">
<td class="tblQmlPropNode"><p>
<a name="instructionText-prop"></a><span class="name">instructionText</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This read-only property holds textual navigation instruction.</p>
</div></div><!-- @@@instructionText -->
<br/>
<!-- $$$position -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="position-prop">
<td class="tblQmlPropNode"><p>
<a name="position-prop"></a><span class="name">position</span> : <span class="type">coordinate</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This read-only property holds where the <a href="qml-qtlocation-routemaneuver.html#instructionText-prop">instructionText</a> should be displayed.</p>
</div></div><!-- @@@position -->
<br/>
<!-- $$$timeToNextInstruction -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="timeToNextInstruction-prop">
<td class="tblQmlPropNode"><p>
<a name="timeToNextInstruction-prop"></a><span class="name">timeToNextInstruction</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This read-only property holds the estimated time it will take to travel from the point at which the associated instruction was issued and the point that the next instruction should be issued, in seconds.</p>
</div></div><!-- @@@timeToNextInstruction -->
<br/>
<!-- $$$valid -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="valid-prop">
<td class="tblQmlPropNode"><p>
<a name="valid-prop"></a><span class="name">valid</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This read-only property holds whether this maneuver is valid or not.</p>
<p>Invalid maneuvers are used when there is no information that needs to be attached to the endpoint of a <a href="qgeoroutesegment.html">QGeoRouteSegment</a> instance.</p>
</div></div><!-- @@@valid -->
<br/>
<!-- $$$waypoint -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="waypoint-prop">
<td class="tblQmlPropNode"><p>
<a name="waypoint-prop"></a><span class="name">waypoint</span> : <span class="type">coordinate</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the waypoint associated with this maneuver. All maneuvers do not have a waypoint associated with them, this can be checked with <a href="qml-qtlocation-routemaneuver.html#waypointValid-prop">waypointValid</a>.</p>
</div></div><!-- @@@waypoint -->
<br/>
<!-- $$$waypointValid -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="waypointValid-prop">
<td class="tblQmlPropNode"><p>
<a name="waypointValid-prop"></a><span class="name">waypointValid</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This read-only property holds whether this <a href="qml-qtlocation-routemaneuver.html#waypoint-prop">waypoint</a>, associated with this maneuver, is valid or not.</p>
</div></div><!-- @@@waypointValid -->
<br/>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</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>