<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qproximityfilter.cpp --> <title>QProximityFilter Class | Qt 3D 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="qt3d-index.html">Qt 3D</a></td><td ><a href="qt3d-cpp.html">C++ Classes</a></td><td >QProximityFilter</td></tr></table><table class="buildversion"><tr> <td id="buildversion" width="100%" align="right"><a href="qt3d-index.html">Qt 5.12.6 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">QProximityFilter Class</h1> <span class="small-subtitle">(<a href="qt3drender-qproximityfilter.html">Qt3DRender::QProximityFilter</a>)<br/></span> <!-- $$$QProximityFilter-brief --> <p>Select entities which are within a distance threshold of a target entity. <a href="#details">More...</a></p> <!-- @@@QProximityFilter --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QProximityFilter></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.10</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiated By:</td><td class="memItemRight bottomAlign"> <a href="qml-qt3d-render-proximityfilter.html">ProximityFilter</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qt3drender-qframegraphnode.html">Qt3DRender::QFrameGraphNode</a></td></tr></table></div><ul> <li><a href="qt3drender-qproximityfilter-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><a href="qt3drender-qproximityfilter.html#distanceThreshold-prop">distanceThreshold</a></b> : float</li> <li class="fn"><b><a href="qt3drender-qproximityfilter.html#entity-prop">entity</a></b> : Qt3DCore::QEntity*</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-qproximityfilter.html#QProximityFilter">QProximityFilter</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="qt3drender-qproximityfilter.html#distanceThreshold-prop">distanceThreshold</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> Qt3DCore::QEntity *</td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qproximityfilter.html#entity-prop">entity</a></b>() const</td></tr> </table></div> <ul> <li class="fn">1 public function inherited from <a href="qt3drender-qframegraphnode.html#public-functions">Qt3DRender::QFrameGraphNode</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="qt3drender-qproximityfilter.html#distanceThreshold-prop">setDistanceThreshold</a></b>(float <i>distanceThreshold</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qproximityfilter.html#entity-prop">setEntity</a></b>(Qt3DCore::QEntity *<i>entity</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-qproximityfilter.html#distanceThreshold-prop">distanceThresholdChanged</a></b>(float <i>distanceThreshold</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qproximityfilter.html#entity-prop">entityChanged</a></b>(Qt3DCore::QEntity *<i>entity</i>)</td></tr> </table></div> <ul> <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="qt3drender-qproximityfilter.html#staticMetaObject-var">staticMetaObject</a></b></td></tr> </table></div> <h3>Additional Inherited Members</h3> <ul> <li class="fn">1 protected function inherited from <a href="qt3drender-qframegraphnode.html#protected-functions">Qt3DRender::QFrameGraphNode</a></li> <li class="fn">2 protected functions inherited from <a href="qt3dcore-qnode.html#protected-functions">Qt3DCore::QNode</a></li> </ul> <a name="details"></a> <!-- $$$QProximityFilter-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>Select entities which are within a distance threshold of a target entity.</p> <p>A <a href="qt3drender-qproximityfilter.html">Qt3DRender::QProximityFilter</a> can be used to select entities to render when they are placed within a given distance threshold of another entity.</p> </div> <!-- @@@QProximityFilter --> <div class="prop"> <h2>Property Documentation</h2> <!-- $$$distanceThreshold-prop$$$distanceThreshold$$$setDistanceThresholdfloat$$$distanceThresholdChangedfloat --> <h3 class="fn" id="distanceThreshold-prop"><a name="distanceThreshold-prop"></a><span class="name">distanceThreshold</span> : <span class="type">float</span></h3> <p>Holds the distance to the target entity above which entities are filtered out.</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>distanceThreshold</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setDistanceThreshold</b></span>(float <i>distanceThreshold</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>distanceThresholdChanged</b></span>(float <i>distanceThreshold</i>)</td></tr> </table></div> <!-- @@@distanceThreshold --> <!-- $$$entity-prop$$$entity$$$setEntityQt3DCore::QEntity*$$$entityChangedQt3DCore::QEntity* --> <h3 class="fn" id="entity-prop"><a name="entity-prop"></a><span class="name">entity</span> : <span class="type"><a href="qt3dcore-qentity.html">Qt3DCore::QEntity</a></span>*</h3> <p>Holds the entity against which we should compare the distance to.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> Qt3DCore::QEntity *</td><td class="memItemRight bottomAlign"><span class="name"><b>entity</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setEntity</b></span>(Qt3DCore::QEntity *<i>entity</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>entityChanged</b></span>(Qt3DCore::QEntity *<i>entity</i>)</td></tr> </table></div> <!-- @@@entity --> </div> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QProximityFilter[overload1]$$$QProximityFilterQt3DCore::QNode* --> <h3 class="fn" id="QProximityFilter"><a name="QProximityFilter"></a>QProximityFilter::<span class="name">QProximityFilter</span>(<span class="type"><a href="qt3dcore-qnode.html">Qt3DCore::QNode</a></span> *<i>parent</i> = nullptr)</h3> <p>Default constructs an instance of QProximityFilter.</p><!-- @@@QProximityFilter --> </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>