<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qheightmapsurfacedataproxy.cpp -->
<title>HeightMapSurfaceDataProxy QML Type | Qt Data Visualization 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="qtdatavisualization-index.html">Qt Data Visualization</a></td><td ><a href="qtdatavisualization-qmlmodule.html">QML Types</a></td><td >HeightMapSurfaceDataProxy QML Type</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtdatavisualization-index.html">Qt Data Visualization | Commercial or GPLv3</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="#properties">Properties</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">HeightMapSurfaceDataProxy QML Type</h1>
<span class="subtitle"></span>
<!-- $$$HeightMapSurfaceDataProxy-brief -->
<p>Base proxy type for <a href="qml-qtdatavisualization-surface3d.html">Surface3D</a>. <a href="#details">More...</a></p>
<!-- @@@HeightMapSurfaceDataProxy -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtDataVisualization 1.2</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> QtDataVisualization 1.0</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiates:</td><td class="memItemRight bottomAlign"> <a href="qml-qtdatavisualization-heightmapsurfacedataproxy.html"><a href="qheightmapsurfacedataproxy.html">QHeightMapSurfaceDataProxy</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <p><a href="qml-qtdatavisualization-surfacedataproxy.html">SurfaceDataProxy</a></p>
</td></tr></table></div><ul>
<li><a href="qml-qtdatavisualization-heightmapsurfacedataproxy-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-qtdatavisualization-heightmapsurfacedataproxy.html#heightMapFile-prop">heightMapFile</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtdatavisualization-heightmapsurfacedataproxy.html#maxXValue-prop">maxXValue</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtdatavisualization-heightmapsurfacedataproxy.html#maxZValue-prop">maxZValue</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtdatavisualization-heightmapsurfacedataproxy.html#minXValue-prop">minXValue</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtdatavisualization-heightmapsurfacedataproxy.html#minZValue-prop">minZValue</a></b></b> : real</li>
</ul>
<!-- $$$HeightMapSurfaceDataProxy-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p><a href="qml-qtdatavisualization-heightmapsurfacedataproxy.html">HeightMapSurfaceDataProxy</a> takes care of surface related height map data handling. It provides a way to give a height map to be visualized as a surface plot.</p>
<p>For more complete description, see <a href="qheightmapsurfacedataproxy.html">QHeightMapSurfaceDataProxy</a>.</p>
<p><b>See also </b><a href="qtdatavisualization-data-handling.html">Qt Data Visualization Data Handling</a>.</p>
<!-- @@@HeightMapSurfaceDataProxy -->
<h2>Property Documentation</h2>
<!-- $$$heightMapFile -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="heightMapFile-prop">
<td class="tblQmlPropNode"><p>
<a name="heightMapFile-prop"></a><span class="name">heightMapFile</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>A file with a height map image to be visualized. Setting this property replaces current data with height map data.</p>
<p>There are several formats the image file can be given in, but if it is not in a directly usable format, a conversion is made.</p>
<p><b>Note: </b>If the result seems wrong, the automatic conversion failed and you should try converting the image yourself before setting it. Preferred format is QImage::Format_RGB32 in grayscale.</p><p>The height of the image is read from the red component of the pixels if the image is in grayscale, otherwise it is an average calculated from red, green and blue components of the pixels. Using grayscale images may improve data conversion speed for large images.</p>
<p>Since height maps do not contain values for X or Z axes, those values need to be given separately using <a href="qml-qtdatavisualization-heightmapsurfacedataproxy.html#minXValue-prop">minXValue</a>, <a href="qml-qtdatavisualization-heightmapsurfacedataproxy.html#maxXValue-prop">maxXValue</a>, <a href="qml-qtdatavisualization-heightmapsurfacedataproxy.html#minZValue-prop">minZValue</a>, and <a href="qml-qtdatavisualization-heightmapsurfacedataproxy.html#maxZValue-prop">maxZValue</a> properties. X-value corresponds to image horizontal direction and Z-value to the vertical. Setting any of these properties triggers asynchronous re-resolving of any existing height map.</p>
<p>Not recommended formats: all mono formats (for example QImage::Format_Mono).</p>
</div></div><!-- @@@heightMapFile -->
<br/>
<!-- $$$maxXValue -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="maxXValue-prop">
<td class="tblQmlPropNode"><p>
<a name="maxXValue-prop"></a><span class="name">maxXValue</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The maximum X value for the generated surface points. Defaults to <code>10.0</code>. When setting this property the corresponding minimum value is adjusted if necessary, to ensure that the range remains valid.</p>
</div></div><!-- @@@maxXValue -->
<br/>
<!-- $$$maxZValue -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="maxZValue-prop">
<td class="tblQmlPropNode"><p>
<a name="maxZValue-prop"></a><span class="name">maxZValue</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The maximum Z value for the generated surface points. Defaults to <code>10.0</code>. When setting this property the corresponding minimum value is adjusted if necessary, to ensure that the range remains valid.</p>
</div></div><!-- @@@maxZValue -->
<br/>
<!-- $$$minXValue -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="minXValue-prop">
<td class="tblQmlPropNode"><p>
<a name="minXValue-prop"></a><span class="name">minXValue</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The minimum X value for the generated surface points. Defaults to <code>0.0</code>. When setting this property the corresponding maximum value is adjusted if necessary, to ensure that the range remains valid.</p>
</div></div><!-- @@@minXValue -->
<br/>
<!-- $$$minZValue -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="minZValue-prop">
<td class="tblQmlPropNode"><p>
<a name="minZValue-prop"></a><span class="name">minZValue</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The minimum Z value for the generated surface points. Defaults to <code>0.0</code>. When setting this property the corresponding maximum value is adjusted if necessary, to ensure that the range remains valid.</p>
</div></div><!-- @@@minZValue -->
<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>
