<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qtorusgeometry.cpp --> <title>QTorusGeometry Class | Qt 3D 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="qt3d-index.html">Qt 3D</a></td><td ><a href="qt3d-cpp.html">C++ Classes</a></td><td >QTorusGeometry</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="#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="#details">Detailed Description</a></li> </ul> </div> <div class="sidebar-content" id="sidebar-content"></div></div> <h1 class="title">QTorusGeometry Class</h1> <span class="small-subtitle">(<a href="qt3dextras-qtorusgeometry.html">Qt3DExtras::QTorusGeometry</a>)<br/></span> <!-- $$$QTorusGeometry-brief --> <p>The <a href="qt3dextras-qtorusgeometry.html">QTorusGeometry</a> class allows creation of a torus in 3D space. <a href="#details">More...</a></p> <!-- @@@QTorusGeometry --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <Qt3DExtras/QTorusGeometry></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-torusgeometry.html">TorusGeometry</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-qtorusgeometry-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-qtorusgeometry.html#indexAttribute-prop">indexAttribute</a></b> : Qt3DRender::QAttribute * const</li> <li class="fn"><b><a href="qt3dextras-qtorusgeometry.html#minorRadius-prop">minorRadius</a></b> : float</li> <li class="fn"><b><a href="qt3dextras-qtorusgeometry.html#normalAttribute-prop">normalAttribute</a></b> : Qt3DRender::QAttribute * const</li> <li class="fn"><b><a href="qt3dextras-qtorusgeometry.html#positionAttribute-prop">positionAttribute</a></b> : Qt3DRender::QAttribute * const</li> </ul></td><td class="topAlign"><ul> <li class="fn"><b><a href="qt3dextras-qtorusgeometry.html#radius-prop">radius</a></b> : float</li> <li class="fn"><b><a href="qt3dextras-qtorusgeometry.html#rings-prop">rings</a></b> : int</li> <li class="fn"><b><a href="qt3dextras-qtorusgeometry.html#slices-prop">slices</a></b> : int</li> <li class="fn"><b><a href="qt3dextras-qtorusgeometry.html#texCoordAttribute-prop">texCoordAttribute</a></b> : Qt3DRender::QAttribute * const</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-qtorusgeometry.html#QTorusGeometry">QTorusGeometry</a></b>(QNode *<i>parent</i> = nullptr)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> Qt3DRender::QAttribute *</td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qtorusgeometry.html#indexAttribute-prop">indexAttribute</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> float </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qtorusgeometry.html#minorRadius-prop">minorRadius</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> Qt3DRender::QAttribute *</td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qtorusgeometry.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-qtorusgeometry.html#positionAttribute-prop">positionAttribute</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> float </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qtorusgeometry.html#radius-prop">radius</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qtorusgeometry.html#rings-prop">rings</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qtorusgeometry.html#slices-prop">slices</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> Qt3DRender::QAttribute *</td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qtorusgeometry.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-qtorusgeometry.html#updateIndices">updateIndices</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qtorusgeometry.html#updateVertices">updateVertices</a></b>()</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">11 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-qtorusgeometry.html#minorRadius-prop">setMinorRadius</a></b>(float <i>minorRadius</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qtorusgeometry.html#radius-prop">setRadius</a></b>(float <i>radius</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qtorusgeometry.html#rings-prop">setRings</a></b>(int <i>rings</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qtorusgeometry.html#slices-prop">setSlices</a></b>(int <i>slices</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-qtorusgeometry.html#minorRadius-prop">minorRadiusChanged</a></b>(float <i>minorRadius</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qtorusgeometry.html#radius-prop">radiusChanged</a></b>(float <i>radius</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qtorusgeometry.html#rings-prop">ringsChanged</a></b>(int <i>rings</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qtorusgeometry.html#slices-prop">slicesChanged</a></b>(int <i>slices</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> <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> <!-- $$$QTorusGeometry-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>The <a href="qt3dextras-qtorusgeometry.html">QTorusGeometry</a> class allows creation of a torus in 3D space.</p> <p>The <a href="qt3dextras-qtorusgeometry.html">QTorusGeometry</a> class is most commonly used internally by the <a href="qt3dextras-qtorusmesh.html">QTorusMesh</a> but can also be used in custom <a href="qt3drender-qgeometryrenderer.html">Qt3DRender::QGeometryRenderer</a> subclasses.</p> </div> <!-- @@@QTorusGeometry --> <div class="prop"> <h2>Property Documentation</h2> <!-- $$$indexAttribute-prop$$$indexAttribute --> <h3 class="fn" id="indexAttribute-prop"><a name="indexAttribute-prop"></a><span class="name">indexAttribute</span> : <span class="type">Qt3DRender::QAttribute</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 --> <!-- $$$minorRadius-prop$$$minorRadius$$$setMinorRadiusfloat$$$minorRadiusChangedfloat --> <h3 class="fn" id="minorRadius-prop"><a name="minorRadius-prop"></a><span class="name">minorRadius</span> : <span class="type">float</span></h3> <p>Holds the inner radius of the torus.</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>minorRadius</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setMinorRadius</b></span>(float <i>minorRadius</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>minorRadiusChanged</b></span>(float <i>minorRadius</i>)</td></tr> </table></div> <!-- @@@minorRadius --> <!-- $$$normalAttribute-prop$$$normalAttribute --> <h3 class="fn" id="normalAttribute-prop"><a name="normalAttribute-prop"></a><span class="name">normalAttribute</span> : <span class="type">Qt3DRender::QAttribute</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">Qt3DRender::QAttribute</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 --> <!-- $$$radius-prop$$$radius$$$setRadiusfloat$$$radiusChangedfloat --> <h3 class="fn" id="radius-prop"><a name="radius-prop"></a><span class="name">radius</span> : <span class="type">float</span></h3> <p>Holds the outer radius of the torus.</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>radius</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setRadius</b></span>(float <i>radius</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>radiusChanged</b></span>(float <i>radius</i>)</td></tr> </table></div> <!-- @@@radius --> <!-- $$$rings-prop$$$rings$$$setRingsint$$$ringsChangedint --> <h3 class="fn" id="rings-prop"><a name="rings-prop"></a><span class="name">rings</span> : <span class="type">int</span></h3> <p>Holds the number of rings in the torus.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>rings</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setRings</b></span>(int <i>rings</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>ringsChanged</b></span>(int <i>rings</i>)</td></tr> </table></div> <!-- @@@rings --> <!-- $$$slices-prop$$$slices$$$setSlicesint$$$slicesChangedint --> <h3 class="fn" id="slices-prop"><a name="slices-prop"></a><span class="name">slices</span> : <span class="type">int</span></h3> <p>Holds the number of slices in the torus.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>slices</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setSlices</b></span>(int <i>slices</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>slicesChanged</b></span>(int <i>slices</i>)</td></tr> </table></div> <!-- @@@slices --> <!-- $$$texCoordAttribute-prop$$$texCoordAttribute --> <h3 class="fn" id="texCoordAttribute-prop"><a name="texCoordAttribute-prop"></a><span class="name">texCoordAttribute</span> : <span class="type">Qt3DRender::QAttribute</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 --> </div> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QTorusGeometry[overload1]$$$QTorusGeometryQNode* --> <h3 class="fn" id="QTorusGeometry"><a name="QTorusGeometry"></a>QTorusGeometry::<span class="name">QTorusGeometry</span>(<span class="type"><a href="qt3dcore-qnode.html#QNode">QNode</a></span> *<i>parent</i> = nullptr)</h3> <p>Constructs a new <a href="qt3dextras-qtorusgeometry.html">QTorusGeometry</a> with <i>parent</i>.</p> <!-- @@@QTorusGeometry --> <!-- $$$updateIndices[overload1]$$$updateIndices --> <h3 class="fn" id="updateIndices"><a name="updateIndices"></a><span class="type">void</span> QTorusGeometry::<span class="name">updateIndices</span>()</h3> <p>Updates indices based on rings and slices properties.</p> <!-- @@@updateIndices --> <!-- $$$updateVertices[overload1]$$$updateVertices --> <h3 class="fn" id="updateVertices"><a name="updateVertices"></a><span class="type">void</span> QTorusGeometry::<span class="name">updateVertices</span>()</h3> <p>Updates vertices based on rings, slices, and radius properties.</p> <!-- @@@updateVertices --> </div> </div> </div> </div> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</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>