<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qobjectpicker.cpp -->
<title>QObjectPicker 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 >QObjectPicker</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">QObjectPicker Class</h1>
<span class="small-subtitle">(<a href="qt3drender-qobjectpicker.html">Qt3DRender::QObjectPicker</a>)<br/></span>
<!-- $$$QObjectPicker-brief -->
<p>The <a href="qt3drender-qobjectpicker.html">QObjectPicker</a> class instantiates a component that can be used to interact with a QEntity by a process known as picking. <a href="#details">More...</a></p>
<!-- @@@QObjectPicker -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QObjectPicker></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.6</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiated By:</td><td class="memItemRight bottomAlign"> <a href="qml-qt3d-render-objectpicker.html">ObjectPicker</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qt3dcore-qcomponent.html">Qt3DCore::QComponent</a></td></tr></table></div><ul>
<li><a href="qt3drender-qobjectpicker-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-qobjectpicker.html#containsMouse-prop">containsMouse</a></b> : const bool</li>
<li class="fn"><b><a href="qt3drender-qobjectpicker.html#dragEnabled-prop">dragEnabled</a></b> : bool</li>
<li class="fn"><b><a href="qt3drender-qobjectpicker.html#hoverEnabled-prop">hoverEnabled</a></b> : bool</li>
<li class="fn"><b><a href="qt3drender-qobjectpicker.html#pressed-prop">pressed</a></b> : const bool</li>
</ul>
<ul>
<li class="fn">1 property inherited from <a href="qt3dcore-qcomponent.html#properties">Qt3DCore::QComponent</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="qt3drender-qobjectpicker.html#QObjectPicker">QObjectPicker</a></b>(Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qobjectpicker.html#containsMouse">containsMouse</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qobjectpicker.html#isDragEnabled">isDragEnabled</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qobjectpicker.html#isHoverEnabled">isHoverEnabled</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qobjectpicker.html#pressed-prop">isPressed</a></b>() const</td></tr>
</table></div>
<ul>
<li class="fn">2 public functions inherited from <a href="qt3dcore-qcomponent.html#public-functions">Qt3DCore::QComponent</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-qobjectpicker.html#setDragEnabled">setDragEnabled</a></b>(bool <i>dragEnabled</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qobjectpicker.html#setHoverEnabled">setHoverEnabled</a></b>(bool <i>hoverEnabled</i>)</td></tr>
</table></div>
<ul>
<li class="fn">1 public slot inherited from <a href="qt3dcore-qcomponent.html#public-slots">Qt3DCore::QComponent</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="qt3drender-qobjectpicker.html#clicked">clicked</a></b>(Qt3DRender::QPickEvent *<i>pick</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qobjectpicker.html#containsMouse-prop">containsMouseChanged</a></b>(bool <i>containsMouse</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qobjectpicker.html#dragEnabled-prop">dragEnabledChanged</a></b>(bool <i>dragEnabled</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qobjectpicker.html#entered">entered</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qobjectpicker.html#exited">exited</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qobjectpicker.html#hoverEnabled-prop">hoverEnabledChanged</a></b>(bool <i>hoverEnabled</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qobjectpicker.html#moved">moved</a></b>(Qt3DRender::QPickEvent *<i>pick</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qobjectpicker.html#pressed">pressed</a></b>(Qt3DRender::QPickEvent *<i>pick</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qobjectpicker.html#pressed-prop">pressedChanged</a></b>(bool <i>pressed</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3drender-qobjectpicker.html#released">released</a></b>(Qt3DRender::QPickEvent *<i>pick</i>)</td></tr>
</table></div>
<ul>
<li class="fn">3 signals inherited from <a href="qt3dcore-qcomponent.html#signals">Qt3DCore::QComponent</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="qt3drender-qobjectpicker.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>
<!-- $$$QObjectPicker-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qt3drender-qobjectpicker.html">QObjectPicker</a> class instantiates a component that can be used to interact with a QEntity by a process known as picking.</p>
<p>For every combination of viewport and camera, picking casts a ray through the scene to find entities who's bounding volume intersects the ray. The bounding volume is computed using the values in the attribute buffer specified by the boundingVolumePositionAttribute of the geometry.</p>
<p>The signals <a href="qt3drender-qobjectpicker.html#pressed">pressed</a>(), <a href="qt3drender-qobjectpicker.html#released">released</a>(), <a href="qt3drender-qobjectpicker.html#clicked">clicked</a>(), <a href="qt3drender-qobjectpicker.html#moved">moved</a>(), <a href="qt3drender-qobjectpicker.html#entered">entered</a>(), and <a href="qt3drender-qobjectpicker.html#exited">exited</a>() are emitted when the bounding volume defined by the pickAttribute property intersects with a ray.</p>
<p>Most signals carry a <a href="qt3drender-qpickevent.html">QPickEvent</a> instance. If QPickingSettings::pickMode() is set to <a href="qt3drender-qpickingsettings.html#PickMethod-enum">QPickingSettings::TrianglePicking</a>, the actual type of the pick parameter will be <a href="qt3drender-qpicktriangleevent.html">QPickTriangleEvent</a>.</p>
<p>Pick queries are performed on mouse press and mouse release. If drag is enabled, queries also happen on each mouse move while any button is pressed. If hover is enabled, queries happen on every mouse move even if no button is pressed.</p>
<p>For generalised ray casting queries, see <a href="qt3drender-qraycaster.html">Qt3DRender::QRayCaster</a> and <a href="qt3drender-qscreenraycaster.html">Qt3DRender::QScreenRayCaster</a>.</p>
<p><b>Note: </b>Instances of this component shouldn't be shared, not respecting that condition will most likely result in undefined behavior.</p></div>
<p><b>See also </b><a href="qt3drender-qpickingsettings.html">Qt3DRender::QPickingSettings</a>, <a href="qt3drender-qgeometry.html">Qt3DRender::QGeometry</a>, <a href="qt3drender-qattribute.html">Qt3DRender::QAttribute</a>, <a href="qt3drender-qpickevent.html">Qt3DRender::QPickEvent</a>, and <a href="qt3drender-qpicktriangleevent.html">Qt3DRender::QPickTriangleEvent</a>.</p>
<!-- @@@QObjectPicker -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$containsMouse-prop$$$containsMouse$$$containsMouseChangedbool -->
<h3 class="fn" id="containsMouse-prop"><a name="containsMouse-prop"></a><span class="name">containsMouse</span> : const <span class="type">bool</span></h3>
<p>Specifies if the object picker currently contains the mouse</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><a href="qt3drender-qobjectpicker.html#containsMouse">containsMouse</a></b></span>() const</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>containsMouseChanged</b></span>(bool <i>containsMouse</i>)</td></tr>
</table></div>
<!-- @@@containsMouse -->
<!-- $$$dragEnabled-prop$$$isDragEnabled$$$setDragEnabledbool$$$dragEnabledChangedbool -->
<h3 class="fn" id="dragEnabled-prop"><a name="dragEnabled-prop"></a><span class="name">dragEnabled</span> : <span class="type">bool</span></h3>
<p>Specifies if drag is enabled</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><a href="qt3drender-qobjectpicker.html#isDragEnabled">isDragEnabled</a></b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qt3drender-qobjectpicker.html#setDragEnabled">setDragEnabled</a></b></span>(bool <i>dragEnabled</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>dragEnabledChanged</b></span>(bool <i>dragEnabled</i>)</td></tr>
</table></div>
<!-- @@@dragEnabled -->
<!-- $$$hoverEnabled-prop$$$isHoverEnabled$$$setHoverEnabledbool$$$hoverEnabledChangedbool -->
<h3 class="fn" id="hoverEnabled-prop"><a name="hoverEnabled-prop"></a><span class="name">hoverEnabled</span> : <span class="type">bool</span></h3>
<p>Specifies if hover is enabled</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><a href="qt3drender-qobjectpicker.html#isHoverEnabled">isHoverEnabled</a></b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qt3drender-qobjectpicker.html#setHoverEnabled">setHoverEnabled</a></b></span>(bool <i>hoverEnabled</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>hoverEnabledChanged</b></span>(bool <i>hoverEnabled</i>)</td></tr>
</table></div>
<!-- @@@hoverEnabled -->
<!-- $$$pressed-prop$$$isPressed$$$pressedChangedbool -->
<h3 class="fn" id="pressed-prop"><a name="pressed-prop"></a><span class="name">pressed</span> : const <span class="type">bool</span></h3>
<p>Specifies if the object picker is currently pressed</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>isPressed</b></span>() const</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>pressedChanged</b></span>(bool <i>pressed</i>)</td></tr>
</table></div>
<!-- @@@pressed -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QObjectPicker[overload1]$$$QObjectPickerQt3DCore::QNode* -->
<h3 class="fn" id="QObjectPicker"><a name="QObjectPicker"></a>QObjectPicker::<span class="name">QObjectPicker</span>(<span class="type"><a href="qt3dcore-qnode.html">Qt3DCore::QNode</a></span> *<i>parent</i> = nullptr)</h3>
<p>Default constructs an instance of QObjectPicker.</p><!-- @@@QObjectPicker -->
<!-- $$$clicked[overload1]$$$clickedQt3DRender::QPickEvent* -->
<h3 class="fn" id="clicked"><a name="clicked"></a><code>[signal] </code><span class="type">void</span> QObjectPicker::<span class="name">clicked</span>(<span class="type"><a href="qt3drender-qpickevent.html">Qt3DRender::QPickEvent</a></span> *<i>pick</i>)</h3>
<!-- @@@clicked -->
<!-- $$$containsMouse -->
<h3 class="fn" id="containsMouse"><a name="containsMouse"></a><span class="type">bool</span> QObjectPicker::<span class="name">containsMouse</span>() const</h3>
<p>Returns true if the object picker currently contains the mouse</p>
<p><b>Note:</b> Getter function for property <a href="qt3drender-qobjectpicker.html#containsMouse-prop">containsMouse</a>. </p><!-- @@@containsMouse -->
<!-- $$$entered[overload1]$$$entered -->
<h3 class="fn" id="entered"><a name="entered"></a><code>[signal] </code><span class="type">void</span> QObjectPicker::<span class="name">entered</span>()</h3>
<!-- @@@entered -->
<!-- $$$exited[overload1]$$$exited -->
<h3 class="fn" id="exited"><a name="exited"></a><code>[signal] </code><span class="type">void</span> QObjectPicker::<span class="name">exited</span>()</h3>
<!-- @@@exited -->
<!-- $$$isDragEnabled -->
<h3 class="fn" id="isDragEnabled"><a name="isDragEnabled"></a><span class="type">bool</span> QObjectPicker::<span class="name">isDragEnabled</span>() const</h3>
<p>Returns true if dragging is enabled</p>
<p><b>Note:</b> Getter function for property <a href="qt3drender-qobjectpicker.html#dragEnabled-prop">dragEnabled</a>. </p><!-- @@@isDragEnabled -->
<!-- $$$isHoverEnabled -->
<h3 class="fn" id="isHoverEnabled"><a name="isHoverEnabled"></a><span class="type">bool</span> QObjectPicker::<span class="name">isHoverEnabled</span>() const</h3>
<p>Returns true if hover enabled</p>
<p><b>Note:</b> Getter function for property <a href="qt3drender-qobjectpicker.html#hoverEnabled-prop">hoverEnabled</a>. </p><!-- @@@isHoverEnabled -->
<!-- $$$moved[overload1]$$$movedQt3DRender::QPickEvent* -->
<h3 class="fn" id="moved"><a name="moved"></a><code>[signal] </code><span class="type">void</span> QObjectPicker::<span class="name">moved</span>(<span class="type"><a href="qt3drender-qpickevent.html">Qt3DRender::QPickEvent</a></span> *<i>pick</i>)</h3>
<!-- @@@moved -->
<!-- $$$pressed[overload1]$$$pressedQt3DRender::QPickEvent* -->
<h3 class="fn" id="pressed"><a name="pressed"></a><code>[signal] </code><span class="type">void</span> QObjectPicker::<span class="name">pressed</span>(<span class="type"><a href="qt3drender-qpickevent.html">Qt3DRender::QPickEvent</a></span> *<i>pick</i>)</h3>
<!-- @@@pressed -->
<!-- $$$released[overload1]$$$releasedQt3DRender::QPickEvent* -->
<h3 class="fn" id="released"><a name="released"></a><code>[signal] </code><span class="type">void</span> QObjectPicker::<span class="name">released</span>(<span class="type"><a href="qt3drender-qpickevent.html">Qt3DRender::QPickEvent</a></span> *<i>pick</i>)</h3>
<!-- @@@released -->
<!-- $$$setDragEnabled -->
<h3 class="fn" id="setDragEnabled"><a name="setDragEnabled"></a><code>[slot] </code><span class="type">void</span> QObjectPicker::<span class="name">setDragEnabled</span>(<span class="type">bool</span> <i>dragEnabled</i>)</h3>
<p>Sets the <a href="qt3drender-qobjectpicker.html#dragEnabled-prop">dragEnabled</a> Property to <i>dragEnabled</i></p>
<p><b>Note:</b> Setter function for property <a href="qt3drender-qobjectpicker.html#dragEnabled-prop">dragEnabled</a>. </p><p><b>See also </b><a href="qt3drender-qobjectpicker.html#isDragEnabled">isDragEnabled</a>().</p>
<!-- @@@setDragEnabled -->
<!-- $$$setHoverEnabled -->
<h3 class="fn" id="setHoverEnabled"><a name="setHoverEnabled"></a><code>[slot] </code><span class="type">void</span> QObjectPicker::<span class="name">setHoverEnabled</span>(<span class="type">bool</span> <i>hoverEnabled</i>)</h3>
<p>Sets the <a href="qt3drender-qobjectpicker.html#hoverEnabled-prop">hoverEnabled</a> Property to <i>hoverEnabled</i></p>
<p><b>Note:</b> Setter function for property <a href="qt3drender-qobjectpicker.html#hoverEnabled-prop">hoverEnabled</a>. </p><p><b>See also </b><a href="qt3drender-qobjectpicker.html#isHoverEnabled">isHoverEnabled</a>().</p>
<!-- @@@setHoverEnabled -->
</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>
