<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qpickingsettings.cpp --> <title>QPickingSettings 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 >QPickingSettings</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="#public-types">Public Types</a></li> <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">QPickingSettings Class</h1> <span class="small-subtitle">(<a href="qt3drender-qpickingsettings.html">Qt3DRender::QPickingSettings</a>)<br/></span> <!-- $$$QPickingSettings-brief --> <p>The <a href="qt3drender-qpickingsettings.html">QPickingSettings</a> class specifies how entity picking is handled. <a href="#details">More...</a></p> <!-- @@@QPickingSettings --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QPickingSettings></span> </td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += 3drender</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-render-pickingsettings.html">PickingSettings</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qt3dcore-qnode.html">Qt3DCore::QNode</a></td></tr></table></div><ul> <li><a href="qt3drender-qpickingsettings-members.html">List of all members, including inherited members</a></li> </ul> <a name="public-types"></a> <h2 id="public-types">Public Types</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qpickingsettings.html#FaceOrientationPickingMode-enum">FaceOrientationPickingMode</a></b> { FrontFace, BackFace, FrontAndBackFace }</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qpickingsettings.html#PickMethod-enum">PickMethod</a></b> { BoundingVolumePicking, TrianglePicking }</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qpickingsettings.html#PickResultMode-enum">PickResultMode</a></b> { NearestPick, AllPicks }</td></tr> </table></div> <a name="properties"></a> <h2 id="properties">Properties</h2> <ul> <li class="fn"><b><a href="qt3drender-qpickingsettings.html#faceOrientationPickingMode-prop">faceOrientationPickingMode</a></b> : FaceOrientationPickingMode</li> <li class="fn"><b><a href="qt3drender-qpickingsettings.html#pickMethod-prop">pickMethod</a></b> : PickMethod</li> <li class="fn"><b><a href="qt3drender-qpickingsettings.html#pickResultMode-prop">pickResultMode</a></b> : PickResultMode</li> </ul> <ul> <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="qt3drender-qpickingsettings.html#QPickingSettings">QPickingSettings</a></b>(Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> FaceOrientationPickingMode </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qpickingsettings.html#faceOrientationPickingMode-prop">faceOrientationPickingMode</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> PickMethod </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qpickingsettings.html#pickMethod-prop">pickMethod</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> PickResultMode </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qpickingsettings.html#pickResultMode-prop">pickResultMode</a></b>() const</td></tr> </table></div> <ul> <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="qt3drender-qpickingsettings.html#faceOrientationPickingMode-prop">setFaceOrientationPickingMode</a></b>(FaceOrientationPickingMode <i>faceOrientationPickingMode</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qpickingsettings.html#pickMethod-prop">setPickMethod</a></b>(PickMethod <i>pickMethod</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qpickingsettings.html#pickResultMode-prop">setPickResultMode</a></b>(PickResultMode <i>pickResultMode</i>)</td></tr> </table></div> <ul> <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="qt3drender-qpickingsettings.html#faceOrientationPickingMode-prop">faceOrientationPickingModeChanged</a></b>(QPickingSettings::FaceOrientationPickingMode <i>faceOrientationPickingMode</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qpickingsettings.html#pickMethod-prop">pickMethodChanged</a></b>(QPickingSettings::PickMethod <i>pickMethod</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qpickingsettings.html#pickResultMode-prop">pickResultModeChanged</a></b>(QPickingSettings::PickResultMode <i>pickResult</i>)</td></tr> </table></div> <ul> <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> <!-- $$$QPickingSettings-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>The <a href="qt3drender-qpickingsettings.html">QPickingSettings</a> class specifies how entity picking is handled.</p> <p>The picking settings determine how the entity picking is handled. For more details about entity picking, see <a href="qt3drender-qobjectpicker.html">QObjectPicker</a> component documentation.</p> <p>Picking is triggered by mouse events. It will cast a ray through the scene and look for geometry intersecting the ray.</p> </div> <p><b>See also </b><a href="qt3drender-qobjectpicker.html">QObjectPicker</a>, <a href="qt3drender-qpickevent.html">QPickEvent</a>, and <a href="qt3drender-qpicktriangleevent.html">QPickTriangleEvent</a>.</p> <!-- @@@QPickingSettings --> <div class="types"> <h2>Member Type Documentation</h2> <!-- $$$FaceOrientationPickingMode$$$FrontFace$$$BackFace$$$FrontAndBackFace --> <h3 class="fn" id="FaceOrientationPickingMode-enum"><a name="FaceOrientationPickingMode-enum"></a>enum QPickingSettings::<span class="name">FaceOrientationPickingMode</span></h3> <p>Specifies how face orientation affects triangle picking</p> <div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr> <tr><td class="topAlign"><code>Qt3DRender::QPickingSettings::FrontFace</code></td><td class="topAlign tblval"><code>0x01</code></td><td class="topAlign">Only front-facing triangles will be picked (default).</td></tr> <tr><td class="topAlign"><code>Qt3DRender::QPickingSettings::BackFace</code></td><td class="topAlign tblval"><code>0x02</code></td><td class="topAlign">Only back-facing triangles will be picked.</td></tr> <tr><td class="topAlign"><code>Qt3DRender::QPickingSettings::FrontAndBackFace</code></td><td class="topAlign tblval"><code>0x03</code></td><td class="topAlign">Both front- and back-facing triangles will be picked.</td></tr> </table></div> <!-- @@@FaceOrientationPickingMode --> <!-- $$$PickMethod$$$BoundingVolumePicking$$$TrianglePicking --> <h3 class="fn" id="PickMethod-enum"><a name="PickMethod-enum"></a>enum QPickingSettings::<span class="name">PickMethod</span></h3> <p>Specifies the picking method.</p> <div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr> <tr><td class="topAlign"><code>Qt3DRender::QPickingSettings::BoundingVolumePicking</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">An entity is considered picked if the picking ray intersects the bounding volume of the entity (default).</td></tr> <tr><td class="topAlign"><code>Qt3DRender::QPickingSettings::TrianglePicking</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">An entity is considered picked if the picking ray intersects with any triangle of the entity's mesh component.</td></tr> </table></div> <!-- @@@PickMethod --> <!-- $$$PickResultMode$$$NearestPick$$$AllPicks --> <h3 class="fn" id="PickResultMode-enum"><a name="PickResultMode-enum"></a>enum QPickingSettings::<span class="name">PickResultMode</span></h3> <p>Specifies what is included into the picking results.</p> <div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr> <tr><td class="topAlign"><code>Qt3DRender::QPickingSettings::NearestPick</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">Only the nearest entity to picking ray origin intersected by the picking ray is picked (default).</td></tr> <tr><td class="topAlign"><code>Qt3DRender::QPickingSettings::AllPicks</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">All entities that intersect the picking ray are picked.</td></tr> </table></div> <p><b>See also </b><a href="qt3drender-qpickevent.html">Qt3DRender::QPickEvent</a>.</p> <!-- @@@PickResultMode --> </div> <div class="prop"> <h2>Property Documentation</h2> <!-- $$$faceOrientationPickingMode-prop$$$faceOrientationPickingMode$$$setFaceOrientationPickingModeFaceOrientationPickingMode$$$faceOrientationPickingModeChangedQPickingSettings::FaceOrientationPickingMode --> <h3 class="fn" id="faceOrientationPickingMode-prop"><a name="faceOrientationPickingMode-prop"></a><span class="name">faceOrientationPickingMode</span> : <span class="type"><a href="qt3drender-qpickingsettings.html#FaceOrientationPickingMode-enum">FaceOrientationPickingMode</a></span></h3> <p>Specifies how face orientation affects triangle picking</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> FaceOrientationPickingMode </td><td class="memItemRight bottomAlign"><span class="name"><b>faceOrientationPickingMode</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setFaceOrientationPickingMode</b></span>(FaceOrientationPickingMode <i>faceOrientationPickingMode</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>faceOrientationPickingModeChanged</b></span>(QPickingSettings::FaceOrientationPickingMode <i>faceOrientationPickingMode</i>)</td></tr> </table></div> <!-- @@@faceOrientationPickingMode --> <!-- $$$pickMethod-prop$$$pickMethod$$$setPickMethodPickMethod$$$pickMethodChangedQPickingSettings::PickMethod --> <h3 class="fn" id="pickMethod-prop"><a name="pickMethod-prop"></a><span class="name">pickMethod</span> : <span class="type"><a href="qt3drender-qpickingsettings.html#PickMethod-enum">PickMethod</a></span></h3> <p>Holds the current pick method.</p> <p>By default, for performance reasons, ray casting will use bounding volume picking. This may however lead to unexpected results if a small object is englobed in the bounding sphere of a large object behind it.</p> <p>Triangle picking will produce exact results but is computationally more expensive.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> PickMethod </td><td class="memItemRight bottomAlign"><span class="name"><b>pickMethod</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setPickMethod</b></span>(PickMethod <i>pickMethod</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>pickMethodChanged</b></span>(QPickingSettings::PickMethod <i>pickMethod</i>)</td></tr> </table></div> <!-- @@@pickMethod --> <!-- $$$pickResultMode-prop$$$pickResultMode$$$setPickResultModePickResultMode$$$pickResultModeChangedQPickingSettings::PickResultMode --> <h3 class="fn" id="pickResultMode-prop"><a name="pickResultMode-prop"></a><span class="name">pickResultMode</span> : <span class="type"><a href="qt3drender-qpickingsettings.html#PickResultMode-enum">PickResultMode</a></span></h3> <p>Holds the current pick results mode.</p> <p>By default, pick results will only be produced for the entity closest to the camera.</p> <p>When setting the pick method to <a href="qt3drender-qpickingsettings.html#PickResultMode-enum">AllPicks</a>, events will be triggered for all the entities with a <a href="qt3drender-qobjectpicker.html">QObjectPicker</a> along the ray.</p> <p>If a <a href="qt3drender-qobjectpicker.html">QObjectPicker</a> is assigned to an entity with multiple children, an event will be triggered for each child entity that intersects the ray.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> PickResultMode </td><td class="memItemRight bottomAlign"><span class="name"><b>pickResultMode</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setPickResultMode</b></span>(PickResultMode <i>pickResultMode</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>pickResultModeChanged</b></span>(QPickingSettings::PickResultMode <i>pickResult</i>)</td></tr> </table></div> <!-- @@@pickResultMode --> </div> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QPickingSettings[overload1]$$$QPickingSettingsQt3DCore::QNode* --> <h3 class="fn" id="QPickingSettings"><a name="QPickingSettings"></a>QPickingSettings::<span class="name">QPickingSettings</span>(<span class="type">Qt3DCore::QNode</span> *<i>parent</i> = nullptr)</h3> <p>Default constructs an instance of QPickingSettings.</p><!-- @@@QPickingSettings --> </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>