<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qplanegeometry.cpp -->
<title>QPlaneGeometry Class | Qt 3D 5.12.2</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="qt3d-index.html">Qt 3D</a></td><td ><a href="qt3d-cpp.html">C++ Classes</a></td><td >QPlaneGeometry</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qt3d-index.html">Qt 5.12.2 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="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#public-slots">Public Slots</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</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">QPlaneGeometry Class</h1>
<span class="small-subtitle">(<a href="qt3dextras-qplanegeometry.html">Qt3DExtras::QPlaneGeometry</a>)<br/></span>
<!-- $$$QPlaneGeometry-brief -->
<p>The <a href="qt3dextras-qplanegeometry.html">QPlaneGeometry</a> class allows creation of a plane in 3D space. * * * * The <a href="qt3dextras-qplanegeometry.html">QPlaneGeometry</a> class is most commonly used internally by the <a href="qt3dextras-qplanemesh.html">QPlaneMesh</a> * but can also be used in custom <a href="qt3drender-qgeometryrenderer.html">Qt3DRender::QGeometryRenderer</a> subclasses. <a href="#details">More...</a></p>
<!-- @@@QPlaneGeometry -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <Qt3DExtras/QPlaneGeometry></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += 3dextras</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.7</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiated By:</td><td class="memItemRight bottomAlign"> <a href="qml-qt3d-extras-planegeometry.html">PlaneGeometry</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qt3drender-qgeometry.html">Qt3DRender::QGeometry</a></td></tr></table></div><ul>
<li><a href="qt3dextras-qplanegeometry-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<div class="table"><table class="propsummary">
<tr><td class="topAlign"><ul>
<li class="fn"><b><a href="qt3dextras-qplanegeometry.html#height-prop">height</a></b> : float</li>
<li class="fn"><b><a href="qt3dextras-qplanegeometry.html#indexAttribute-prop">indexAttribute</a></b> : Qt3DRender::QAttribute* const</li>
<li class="fn"><b><a href="qt3dextras-qplanegeometry.html#mirrored-prop">mirrored</a></b> : bool</li>
<li class="fn"><b><a href="qt3dextras-qplanegeometry.html#normalAttribute-prop">normalAttribute</a></b> : Qt3DRender::QAttribute* const</li>
<li class="fn"><b><a href="qt3dextras-qplanegeometry.html#positionAttribute-prop">positionAttribute</a></b> : Qt3DRender::QAttribute* const</li>
</ul></td><td class="topAlign"><ul>
<li class="fn"><b><a href="qt3dextras-qplanegeometry.html#resolution-prop">resolution</a></b> : QSize</li>
<li class="fn"><b><a href="qt3dextras-qplanegeometry.html#tangentAttribute-prop">tangentAttribute</a></b> : Qt3DRender::QAttribute* const</li>
<li class="fn"><b><a href="qt3dextras-qplanegeometry.html#texCoordAttribute-prop">texCoordAttribute</a></b> : Qt3DRender::QAttribute* const</li>
<li class="fn"><b><a href="qt3dextras-qplanegeometry.html#width-prop">width</a></b> : float</li>
</ul>
</td></tr>
</table></div>
<ul>
<li class="fn">1 property inherited from <a href="qt3drender-qgeometry.html#properties">Qt3DRender::QGeometry</a></li>
<li class="fn">3 properties inherited from <a href="qt3dcore-qnode.html#properties">Qt3DCore::QNode</a></li>
</ul>
<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="qt3dextras-qplanegeometry.html#QPlaneGeometry">QPlaneGeometry</a></b>(Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> float </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qplanegeometry.html#height-prop">height</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt3DRender::QAttribute *</td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qplanegeometry.html#indexAttribute-prop">indexAttribute</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qplanegeometry.html#mirrored-prop">mirrored</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt3DRender::QAttribute *</td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qplanegeometry.html#normalAttribute-prop">normalAttribute</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt3DRender::QAttribute *</td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qplanegeometry.html#positionAttribute-prop">positionAttribute</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QSize </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qplanegeometry.html#resolution-prop">resolution</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt3DRender::QAttribute *</td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qplanegeometry.html#tangentAttribute-prop">tangentAttribute</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt3DRender::QAttribute *</td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qplanegeometry.html#texCoordAttribute-prop">texCoordAttribute</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qplanegeometry.html#updateIndices">updateIndices</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qplanegeometry.html#updateVertices">updateVertices</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> float </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qplanegeometry.html#width-prop">width</a></b>() const</td></tr>
</table></div>
<ul>
<li class="fn">4 public functions inherited from <a href="qt3drender-qgeometry.html#public-functions">Qt3DRender::QGeometry</a></li>
<li class="fn">13 public functions inherited from <a href="qt3dcore-qnode.html#public-functions">Qt3DCore::QNode</a></li>
</ul>
<a name="public-slots"></a>
<h2 id="public-slots">Public Slots</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qplanegeometry.html#height-prop">setHeight</a></b>(float <i>height</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qplanegeometry.html#mirrored-prop">setMirrored</a></b>(bool <i>mirrored</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qplanegeometry.html#resolution-prop">setResolution</a></b>(const QSize &<i>resolution</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qplanegeometry.html#width-prop">setWidth</a></b>(float <i>width</i>)</td></tr>
</table></div>
<ul>
<li class="fn">1 public slot inherited from <a href="qt3drender-qgeometry.html#public-slots">Qt3DRender::QGeometry</a></li>
<li class="fn">3 public slots inherited from <a href="qt3dcore-qnode.html#public-slots">Qt3DCore::QNode</a></li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qplanegeometry.html#height-prop">heightChanged</a></b>(float <i>height</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qplanegeometry.html#mirrored-prop">mirroredChanged</a></b>(bool <i>mirrored</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qplanegeometry.html#resolution-prop">resolutionChanged</a></b>(const QSize &<i>resolution</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qplanegeometry.html#width-prop">widthChanged</a></b>(float <i>width</i>)</td></tr>
</table></div>
<ul>
<li class="fn">1 signal inherited from <a href="qt3drender-qgeometry.html#signals">Qt3DRender::QGeometry</a></li>
<li class="fn">4 signals inherited from <a href="qt3dcore-qnode.html#signals">Qt3DCore::QNode</a></li>
</ul>
<a name="static-public-members"></a>
<h2 id="static-public-members">Static Public Members</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> const QMetaObject </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qplanegeometry.html#staticMetaObject-var">staticMetaObject</a></b></td></tr>
</table></div>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">2 protected functions inherited from <a href="qt3dcore-qnode.html#protected-functions">Qt3DCore::QNode</a></li>
</ul>
<a name="details"></a>
<!-- $$$QPlaneGeometry-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>* * * *</p>
<p>The <a href="qt3dextras-qplanegeometry.html">QPlaneGeometry</a> class allows creation of a plane in 3D space. * * * * The <a href="qt3dextras-qplanegeometry.html">QPlaneGeometry</a> class is most commonly used internally by the <a href="qt3dextras-qplanemesh.html">QPlaneMesh</a> * but can also be used in custom <a href="qt3drender-qgeometryrenderer.html">Qt3DRender::QGeometryRenderer</a> subclasses.</p>
</div>
<!-- @@@QPlaneGeometry -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$height-prop$$$height$$$setHeightfloat$$$heightChangedfloat -->
<h3 class="fn" id="height-prop"><a name="height-prop"></a><span class="name">height</span> : <span class="type">float</span></h3>
<p>Holds the plane height.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> float </td><td class="memItemRight bottomAlign"><span class="name"><b>height</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setHeight</b></span>(float <i>height</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>heightChanged</b></span>(float <i>height</i>)</td></tr>
</table></div>
<!-- @@@height -->
<!-- $$$indexAttribute-prop$$$indexAttribute -->
<h3 class="fn" id="indexAttribute-prop"><a name="indexAttribute-prop"></a><span class="name">indexAttribute</span> : <span class="type"><a href="qt3drender-qattribute.html">Qt3DRender::QAttribute</a></span>* const</h3>
<p>Holds the geometry index attribute.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> Qt3DRender::QAttribute *</td><td class="memItemRight bottomAlign"><span class="name"><b>indexAttribute</b></span>() const</td></tr>
</table></div>
<!-- @@@indexAttribute -->
<!-- $$$mirrored-prop$$$mirrored$$$setMirroredbool$$$mirroredChangedbool -->
<h3 class="fn" id="mirrored-prop"><a name="mirrored-prop"></a><span class="name">mirrored</span> : <span class="type">bool</span></h3>
<p>Controls if the UV coordinates of the plane should be flipped vertically.</p>
<p>This property was introduced in Qt 5.9.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>mirrored</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setMirrored</b></span>(bool <i>mirrored</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>mirroredChanged</b></span>(bool <i>mirrored</i>)</td></tr>
</table></div>
<!-- @@@mirrored -->
<!-- $$$normalAttribute-prop$$$normalAttribute -->
<h3 class="fn" id="normalAttribute-prop"><a name="normalAttribute-prop"></a><span class="name">normalAttribute</span> : <span class="type"><a href="qt3drender-qattribute.html">Qt3DRender::QAttribute</a></span>* const</h3>
<p>Holds the geometry normal attribute.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> Qt3DRender::QAttribute *</td><td class="memItemRight bottomAlign"><span class="name"><b>normalAttribute</b></span>() const</td></tr>
</table></div>
<!-- @@@normalAttribute -->
<!-- $$$positionAttribute-prop$$$positionAttribute -->
<h3 class="fn" id="positionAttribute-prop"><a name="positionAttribute-prop"></a><span class="name">positionAttribute</span> : <span class="type"><a href="qt3drender-qattribute.html">Qt3DRender::QAttribute</a></span>* const</h3>
<p>Holds the geometry position attribute.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> Qt3DRender::QAttribute *</td><td class="memItemRight bottomAlign"><span class="name"><b>positionAttribute</b></span>() const</td></tr>
</table></div>
<!-- @@@positionAttribute -->
<!-- $$$resolution-prop$$$resolution$$$setResolutionconstQSize&$$$resolutionChangedconstQSize& -->
<h3 class="fn" id="resolution-prop"><a name="resolution-prop"></a><span class="name">resolution</span> : <span class="type">QSize</span></h3>
<p>Holds the plane resolution.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QSize </td><td class="memItemRight bottomAlign"><span class="name"><b>resolution</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setResolution</b></span>(const QSize &<i>resolution</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>resolutionChanged</b></span>(const QSize &<i>resolution</i>)</td></tr>
</table></div>
<!-- @@@resolution -->
<!-- $$$tangentAttribute-prop$$$tangentAttribute -->
<h3 class="fn" id="tangentAttribute-prop"><a name="tangentAttribute-prop"></a><span class="name">tangentAttribute</span> : <span class="type"><a href="qt3drender-qattribute.html">Qt3DRender::QAttribute</a></span>* const</h3>
<p>Holds the geometry tangent attribute.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> Qt3DRender::QAttribute *</td><td class="memItemRight bottomAlign"><span class="name"><b>tangentAttribute</b></span>() const</td></tr>
</table></div>
<!-- @@@tangentAttribute -->
<!-- $$$texCoordAttribute-prop$$$texCoordAttribute -->
<h3 class="fn" id="texCoordAttribute-prop"><a name="texCoordAttribute-prop"></a><span class="name">texCoordAttribute</span> : <span class="type"><a href="qt3drender-qattribute.html">Qt3DRender::QAttribute</a></span>* const</h3>
<p>Holds the geometry texture coordinate attribute.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> Qt3DRender::QAttribute *</td><td class="memItemRight bottomAlign"><span class="name"><b>texCoordAttribute</b></span>() const</td></tr>
</table></div>
<!-- @@@texCoordAttribute -->
<!-- $$$width-prop$$$width$$$setWidthfloat$$$widthChangedfloat -->
<h3 class="fn" id="width-prop"><a name="width-prop"></a><span class="name">width</span> : <span class="type">float</span></h3>
<p>Holds the plane width.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> float </td><td class="memItemRight bottomAlign"><span class="name"><b>width</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setWidth</b></span>(float <i>width</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>widthChanged</b></span>(float <i>width</i>)</td></tr>
</table></div>
<!-- @@@width -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QPlaneGeometry[overload1]$$$QPlaneGeometryQt3DCore::QNode* -->
<h3 class="fn" id="QPlaneGeometry"><a name="QPlaneGeometry"></a>QPlaneGeometry::<span class="name">QPlaneGeometry</span>(<span class="type"><a href="qt3dcore-qnode.html">Qt3DCore::QNode</a></span> *<i>parent</i> = nullptr)</h3>
<p>Default constructs an instance of QPlaneGeometry.</p><!-- @@@QPlaneGeometry -->
<!-- $$$updateIndices[overload1]$$$updateIndices -->
<h3 class="fn" id="updateIndices"><a name="updateIndices"></a><span class="type">void</span> QPlaneGeometry::<span class="name">updateIndices</span>()</h3>
<p>Updates indices based on mesh resolution.</p>
<!-- @@@updateIndices -->
<!-- $$$updateVertices[overload1]$$$updateVertices -->
<h3 class="fn" id="updateVertices"><a name="updateVertices"></a><span class="type">void</span> QPlaneGeometry::<span class="name">updateVertices</span>()</h3>
<p>Updates vertices based on mesh resolution, width, and height properties.</p>
<!-- @@@updateVertices -->
</div>
</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>
