Sophie

Sophie

distrib > Mageia > 7 > x86_64 > by-pkgid > c936229ef0138f42857f36beadbeda30 > files > 895

qt3d5-doc-5.12.2-2.mga7.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qmousehandler.cpp -->
  <title>QMouseHandler 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 >QMouseHandler</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">QMouseHandler Class</h1>
<span class="small-subtitle">(<a href="qt3dinput-qmousehandler.html">Qt3DInput::QMouseHandler</a>)<br/></span>
<!-- $$$QMouseHandler-brief -->
<p>Provides a means of being notified about mouse events when attached to a <a href="qt3dinput-qmousedevice.html">QMouseDevice</a> instance. <a href="#details">More...</a></p>
<!-- @@@QMouseHandler -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;Qt3DInput/QMouseHandler&gt;</span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += 3dinput</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"> Instantiated By:</td><td class="memItemRight bottomAlign"> <a href="qml-qt3d-input-mousehandler.html">MouseHandler</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="qt3dinput-qmousehandler-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="qt3dinput-qmousehandler.html#containsMouse-prop">containsMouse</a></b> : const bool</li>
<li class="fn"><b><a href="qt3dinput-qmousehandler.html#sourceDevice-prop">sourceDevice</a></b> : Qt3DInput::QMouseDevice*</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="qt3dinput-qmousehandler.html#QMouseHandler">QMouseHandler</a></b>(Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmousehandler.html#dtor.QMouseHandler">~QMouseHandler</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmousehandler.html#containsMouse-prop">containsMouse</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt3DInput::QMouseDevice *</td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmousehandler.html#sourceDevice-prop">sourceDevice</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="qt3dinput-qmousehandler.html#setSourceDevice">setSourceDevice</a></b>(Qt3DInput::QMouseDevice *<i>mouseDevice</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="qt3dinput-qmousehandler.html#clicked">clicked</a></b>(Qt3DInput::QMouseEvent *<i>mouse</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmousehandler.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="qt3dinput-qmousehandler.html#doubleClicked">doubleClicked</a></b>(Qt3DInput::QMouseEvent *<i>mouse</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmousehandler.html#entered">entered</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmousehandler.html#exited">exited</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmousehandler.html#positionChanged">positionChanged</a></b>(Qt3DInput::QMouseEvent *<i>mouse</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmousehandler.html#pressAndHold">pressAndHold</a></b>(Qt3DInput::QMouseEvent *<i>mouse</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmousehandler.html#pressed">pressed</a></b>(Qt3DInput::QMouseEvent *<i>mouse</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmousehandler.html#released">released</a></b>(Qt3DInput::QMouseEvent *<i>mouse</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmousehandler.html#sourceDevice-prop">sourceDeviceChanged</a></b>(Qt3DInput::QMouseDevice *<i>mouseDevice</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmousehandler.html#wheel">wheel</a></b>(Qt3DInput::QWheelEvent *<i>wheel</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="qt3dinput-qmousehandler.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>
<!-- $$$QMouseHandler-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>Provides a means of being notified about mouse events when attached to a <a href="qt3dinput-qmousedevice.html">QMouseDevice</a> instance.</p>
<p><b>Note: </b><a href="qt3dinput-qmousehandler.html">QMouseHandler</a> components shouldn't be shared, not respecting that condition will most likely result in undefined behaviors.</p></div>
<p><b>See also </b><a href="qt3dinput-qmousedevice.html">QMouseDevice</a> and <a href="qt3dinput-qmouseevent.html">QMouseEvent</a>.</p>
<!-- @@@QMouseHandler -->
<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>Holds <code>true</code> if the <a href="qt3dinput-qmousehandler.html">QMouseHandler</a> currently contains the mouse.</p>
<p><b>Note: </b>In this context, contains mean that the ray originating from the mouse is intersecting with the <a href="qt3dcore-qentity.html">Qt3DCore::QEntity</a> that aggregates the current <a href="qt3dinput-qmousehandler.html">QMouseHandler</a> instance component.</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>containsMouse</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 -->
<!-- $$$sourceDevice-prop$$$sourceDevice$$$setSourceDeviceQt3DInput::QMouseDevice*$$$sourceDeviceChangedQt3DInput::QMouseDevice* -->
<h3 class="fn" id="sourceDevice-prop"><a name="sourceDevice-prop"></a><span class="name">sourceDevice</span> : <span class="type"><a href="qt3dinput-qmousedevice.html">Qt3DInput::QMouseDevice</a></span>*</h3>
<p>Holds the current mouse source device of the <a href="qt3dinput-qmousehandler.html">QMouseHandler</a> instance.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> Qt3DInput::QMouseDevice *</td><td class="memItemRight bottomAlign"><span class="name"><b>sourceDevice</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qt3dinput-qmousehandler.html#setSourceDevice">setSourceDevice</a></b></span>(Qt3DInput::QMouseDevice *<i>mouseDevice</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>sourceDeviceChanged</b></span>(Qt3DInput::QMouseDevice *<i>mouseDevice</i>)</td></tr>
</table></div>
<!-- @@@sourceDevice -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QMouseHandler[overload1]$$$QMouseHandlerQt3DCore::QNode* -->
<h3 class="fn" id="QMouseHandler"><a name="QMouseHandler"></a>QMouseHandler::<span class="name">QMouseHandler</span>(<span class="type"><a href="qt3dcore-qnode.html">Qt3DCore::QNode</a></span> *<i>parent</i> = nullptr)</h3>
<p>Constructs a new <a href="qt3dinput-qmousehandler.html">QMouseHandler</a> instance with parent <i>parent</i>.</p>
<!-- @@@QMouseHandler -->
<!-- $$$~QMouseHandler[overload1]$$$~QMouseHandler -->
<h3 class="fn" id="dtor.QMouseHandler"><a name="dtor.QMouseHandler"></a><code>[virtual] </code>QMouseHandler::<span class="name">~QMouseHandler</span>()</h3>
<p>Destroys the instance of QMouseHandler. The destructor is virtual.</p><!-- @@@~QMouseHandler -->
<!-- $$$clicked[overload1]$$$clickedQt3DInput::QMouseEvent* -->
<h3 class="fn" id="clicked"><a name="clicked"></a><code>[signal] </code><span class="type">void</span> QMouseHandler::<span class="name">clicked</span>(<span class="type"><a href="qt3dinput-qmouseevent.html">Qt3DInput::QMouseEvent</a></span> *<i>mouse</i>)</h3>
<!-- @@@clicked -->
<!-- $$$doubleClicked[overload1]$$$doubleClickedQt3DInput::QMouseEvent* -->
<h3 class="fn" id="doubleClicked"><a name="doubleClicked"></a><code>[signal] </code><span class="type">void</span> QMouseHandler::<span class="name">doubleClicked</span>(<span class="type"><a href="qt3dinput-qmouseevent.html">Qt3DInput::QMouseEvent</a></span> *<i>mouse</i>)</h3>
<!-- @@@doubleClicked -->
<!-- $$$entered[overload1]$$$entered -->
<h3 class="fn" id="entered"><a name="entered"></a><code>[signal] </code><span class="type">void</span> QMouseHandler::<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> QMouseHandler::<span class="name">exited</span>()</h3>
<!-- @@@exited -->
<!-- $$$positionChanged[overload1]$$$positionChangedQt3DInput::QMouseEvent* -->
<h3 class="fn" id="positionChanged"><a name="positionChanged"></a><code>[signal] </code><span class="type">void</span> QMouseHandler::<span class="name">positionChanged</span>(<span class="type"><a href="qt3dinput-qmouseevent.html">Qt3DInput::QMouseEvent</a></span> *<i>mouse</i>)</h3>
<!-- @@@positionChanged -->
<!-- $$$pressAndHold[overload1]$$$pressAndHoldQt3DInput::QMouseEvent* -->
<h3 class="fn" id="pressAndHold"><a name="pressAndHold"></a><code>[signal] </code><span class="type">void</span> QMouseHandler::<span class="name">pressAndHold</span>(<span class="type"><a href="qt3dinput-qmouseevent.html">Qt3DInput::QMouseEvent</a></span> *<i>mouse</i>)</h3>
<!-- @@@pressAndHold -->
<!-- $$$pressed[overload1]$$$pressedQt3DInput::QMouseEvent* -->
<h3 class="fn" id="pressed"><a name="pressed"></a><code>[signal] </code><span class="type">void</span> QMouseHandler::<span class="name">pressed</span>(<span class="type"><a href="qt3dinput-qmouseevent.html">Qt3DInput::QMouseEvent</a></span> *<i>mouse</i>)</h3>
<!-- @@@pressed -->
<!-- $$$released[overload1]$$$releasedQt3DInput::QMouseEvent* -->
<h3 class="fn" id="released"><a name="released"></a><code>[signal] </code><span class="type">void</span> QMouseHandler::<span class="name">released</span>(<span class="type"><a href="qt3dinput-qmouseevent.html">Qt3DInput::QMouseEvent</a></span> *<i>mouse</i>)</h3>
<!-- @@@released -->
<!-- $$$setSourceDevice -->
<h3 class="fn" id="setSourceDevice"><a name="setSourceDevice"></a><code>[slot] </code><span class="type">void</span> QMouseHandler::<span class="name">setSourceDevice</span>(<span class="type"><a href="qt3dinput-qmousedevice.html">Qt3DInput::QMouseDevice</a></span> *<i>mouseDevice</i>)</h3>
<p>Sets the mouse device of the <a href="qt3dinput-qmousehandler.html">QMouseHandler</a> instance to <i>mouseDevice</i>.</p>
<p><b>Note:</b> Setter function for property <a href="qt3dinput-qmousehandler.html#sourceDevice-prop">sourceDevice</a>. </p><p><b>See also </b><a href="qt3dinput-qmousehandler.html#sourceDevice-prop">sourceDevice</a>().</p>
<!-- @@@setSourceDevice -->
<!-- $$$wheel[overload1]$$$wheelQt3DInput::QWheelEvent* -->
<h3 class="fn" id="wheel"><a name="wheel"></a><code>[signal] </code><span class="type">void</span> QMouseHandler::<span class="name">wheel</span>(<span class="type"><a href="qt3dinput-qwheelevent.html">Qt3DInput::QWheelEvent</a></span> *<i>wheel</i>)</h3>
<!-- @@@wheel -->
</div>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</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>