<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qclipplane.cpp --> <title>ClipPlane QML Type | 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-core-qmlmodule.html">QML Types</a></td><td >ClipPlane 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> </ul> </div> <div class="sidebar-content" id="sidebar-content"></div></div> <h1 class="title">ClipPlane QML Type</h1> <span class="subtitle"></span> <!-- $$$ClipPlane-brief --> <p>Enables an additional OpenGL clipping plane that can be in shaders using gl_ClipDistance <a href="#details">More...</a></p> <!-- @@@ClipPlane --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import Qt3D.Render 2.0</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.5</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiates:</td><td class="memItemRight bottomAlign"> <a href="qml-qt3d-render-clipplane.html"><a href="qt3drender-qclipplane.html">QClipPlane</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <p><a href="qml-renderstate.html">RenderState</a></p> </td></tr></table></div><ul> <li><a href="qml-qt3d-render-clipplane-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-qt3d-render-clipplane.html#distance-prop">distance</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qt3d-render-clipplane.html#normal-prop">normal</a></b></b> : vector3d</li> <li class="fn"><b><b><a href="qml-qt3d-render-clipplane.html#planeIndex-prop">planeIndex</a></b></b> : int</li> </ul> <!-- $$$ClipPlane-description --> <a name="details"></a> <h2 id="details">Detailed Description</h2> <p>By default, OpenGL supports up to 8 additional clipping planes. <a href="qml-qt3d-render-clipplane.html">ClipPlane</a> allows to enable one of these additional planes. These planes can then be manipulated in the shaders using gl_ClipDistance[i] where i varies between 0 and 7. The underlying implementation may support more than 8 clip planes, but it is not guaranteed.</p> <!-- @@@ClipPlane --> <h2>Property Documentation</h2> <!-- $$$distance --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="distance-prop"> <td class="tblQmlPropNode"><p> <a name="distance-prop"></a><span class="name">distance</span> : <span class="type">real</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>Holds the distance of the plane from the world origin.</p> </div></div><!-- @@@distance --> <br/> <!-- $$$normal --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="normal-prop"> <td class="tblQmlPropNode"><p> <a name="normal-prop"></a><span class="name">normal</span> : <span class="type">vector3d</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>Holds the normal of the plane.</p> </div></div><!-- @@@normal --> <br/> <!-- $$$planeIndex --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="planeIndex-prop"> <td class="tblQmlPropNode"><p> <a name="planeIndex-prop"></a><span class="name">planeIndex</span> : <span class="type">int</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>Holds the index of the plane.</p> <p><b>Note: </b>Usually between 0-7.</p></div></div><!-- @@@planeIndex --> <br/> </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>