<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qmousedevice.cpp --> <title>QMouseDevice 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 >QMouseDevice</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="#reimplemented-public-functions">Reimplemented 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">QMouseDevice Class</h1> <span class="small-subtitle">(<a href="qt3dinput-qmousedevice.html">Qt3DInput::QMouseDevice</a>)<br/></span> <!-- $$$QMouseDevice-brief --> <p>Delegates mouse events to the attached <a href="qml-qt3d-input-mousehandler.html">MouseHandler</a> objects. <a href="#details">More...</a></p> <!-- @@@QMouseDevice --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QMouseDevice></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-mousedevice.html">MouseDevice</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qt3dinput-qabstractphysicaldevice.html">Qt3DInput::QAbstractPhysicalDevice</a></td></tr></table></div><ul> <li><a href="qt3dinput-qmousedevice-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="qt3dinput-qmousedevice.html#Axis-enum">Axis</a></b> { X, Y, WheelX, WheelY }</td></tr> </table></div> <a name="properties"></a> <h2 id="properties">Properties</h2> <ul> <li class="fn"><b><a href="qt3dinput-qmousedevice.html#sensitivity-prop">sensitivity</a></b> : float</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="qt3dinput-qmousedevice.html#QMouseDevice">QMouseDevice</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="qt3dinput-qmousedevice.html#sensitivity-prop">sensitivity</a></b>() const</td></tr> </table></div> <a name="reimplemented-public-functions"></a> <h2 id="reimplemented-public-functions">Reimplemented Public Functions</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmousedevice.html#axisCount">axisCount</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmousedevice.html#axisIdentifier">axisIdentifier</a></b>(const QString &<i>name</i>) const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual QStringList </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmousedevice.html#axisNames">axisNames</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmousedevice.html#buttonCount">buttonCount</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmousedevice.html#buttonIdentifier">buttonIdentifier</a></b>(const QString &<i>name</i>) const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual QStringList </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmousedevice.html#buttonNames">buttonNames</a></b>() const</td></tr> </table></div> <ul> <li class="fn">9 public functions inherited from <a href="qt3dinput-qabstractphysicaldevice.html#public-functions">Qt3DInput::QAbstractPhysicalDevice</a></li> <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="qt3dinput-qmousedevice.html#sensitivity-prop">setSensitivity</a></b>(float <i>value</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="qt3dinput-qmousedevice.html#sensitivity-prop">sensitivityChanged</a></b>(float <i>value</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> <!-- $$$QMouseDevice-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>Delegates mouse events to the attached <a href="qml-qt3d-input-mousehandler.html">MouseHandler</a> objects.</p> <p>A <a href="qt3dinput-qmousedevice.html">QMouseDevice</a> delegates mouse events from physical mouse device to <a href="qt3dinput-qmousehandler.html">QMouseHandler</a> objects. The sensitivity of the mouse can be controlled with the <a href="qt3dinput-qmousedevice.html#sensitivity-prop">QMouseDevice::sensitivity</a> property, which specifies the rate in which the logical mouse coordinates change in response to physical movement of the mouse.</p> </div> <p><b>See also </b><a href="qt3dinput-qmousehandler.html">QMouseHandler</a>.</p> <!-- @@@QMouseDevice --> <div class="types"> <h2>Member Type Documentation</h2> <!-- $$$Axis$$$X$$$Y$$$WheelX$$$WheelY --> <h3 class="fn" id="Axis-enum"><a name="Axis-enum"></a>enum QMouseDevice::<span class="name">Axis</span></h3> <p>The mouse axis.</p> <div class="table"><table class="valuelist"><tr><th class="tblConst">Constant</th><th class="tblVal">Value</th></tr> <tr><td class="topAlign"><code>Qt3DInput::QMouseDevice::X</code></td><td class="topAlign tblval"><code>0</code></td></tr> <tr><td class="topAlign"><code>Qt3DInput::QMouseDevice::Y</code></td><td class="topAlign tblval"><code>1</code></td></tr> <tr><td class="topAlign"><code>Qt3DInput::QMouseDevice::WheelX</code></td><td class="topAlign tblval"><code>2</code></td></tr> <tr><td class="topAlign"><code>Qt3DInput::QMouseDevice::WheelY</code></td><td class="topAlign tblval"><code>3</code></td></tr> </table></div> <p><b>See also </b><a href="qt3dinput-qanalogaxisinput.html#axis-prop">Qt3DInput::QAnalogAxisInput::setAxis</a>.</p> <!-- @@@Axis --> </div> <div class="prop"> <h2>Property Documentation</h2> <!-- $$$sensitivity-prop$$$sensitivity$$$setSensitivityfloat$$$sensitivityChangedfloat --> <h3 class="fn" id="sensitivity-prop"><a name="sensitivity-prop"></a><span class="name">sensitivity</span> : <span class="type">float</span></h3> <p>Holds the sensitivity of the mouse device. The default is 0.1.</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>sensitivity</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setSensitivity</b></span>(float <i>value</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>sensitivityChanged</b></span>(float <i>value</i>)</td></tr> </table></div> <!-- @@@sensitivity --> </div> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QMouseDevice[overload1]$$$QMouseDeviceQt3DCore::QNode* --> <h3 class="fn" id="QMouseDevice"><a name="QMouseDevice"></a>QMouseDevice::<span class="name">QMouseDevice</span>(<span class="type">Qt3DCore::QNode</span> *<i>parent</i> = nullptr)</h3> <p>Default constructs an instance of QMouseDevice.</p><!-- @@@QMouseDevice --> <!-- $$$axisCount[overload1]$$$axisCount --> <h3 class="fn" id="axisCount"><a name="axisCount"></a><code>[virtual] </code><span class="type">int</span> QMouseDevice::<span class="name">axisCount</span>() const</h3> <p>Reimplemented from <a href="qt3dinput-qabstractphysicaldevice.html#axisCount">QAbstractPhysicalDevice::axisCount</a>().</p> <p>Returns the axis count.</p> <p><b>Note: </b>Currently always returns 4.</p><!-- @@@axisCount --> <!-- $$$axisIdentifier[overload1]$$$axisIdentifierconstQString& --> <h3 class="fn" id="axisIdentifier"><a name="axisIdentifier"></a><code>[virtual] </code><span class="type">int</span> QMouseDevice::<span class="name">axisIdentifier</span>(const <span class="type">QString</span> &<i>name</i>) const</h3> <p>Reimplemented from <a href="qt3dinput-qabstractphysicaldevice.html#axisIdentifier">QAbstractPhysicalDevice::axisIdentifier</a>().</p> <p>Convert axis <i>name</i> to axis identifier.</p> <!-- @@@axisIdentifier --> <!-- $$$axisNames[overload1]$$$axisNames --> <h3 class="fn" id="axisNames"><a name="axisNames"></a><code>[virtual] </code><span class="type">QStringList</span> QMouseDevice::<span class="name">axisNames</span>() const</h3> <p>Reimplemented from <a href="qt3dinput-qabstractphysicaldevice.html#axisNames">QAbstractPhysicalDevice::axisNames</a>().</p> <p>Returns the names of the axis.</p> <p><b>Note: </b>Currently always returns StringList["X", "Y"]</p><!-- @@@axisNames --> <!-- $$$buttonCount[overload1]$$$buttonCount --> <h3 class="fn" id="buttonCount"><a name="buttonCount"></a><code>[virtual] </code><span class="type">int</span> QMouseDevice::<span class="name">buttonCount</span>() const</h3> <p>Reimplemented from <a href="qt3dinput-qabstractphysicaldevice.html#buttonCount">QAbstractPhysicalDevice::buttonCount</a>().</p> <p>Returns the button count.</p> <p><b>Note: </b>Currently always returns 3.</p><!-- @@@buttonCount --> <!-- $$$buttonIdentifier[overload1]$$$buttonIdentifierconstQString& --> <h3 class="fn" id="buttonIdentifier"><a name="buttonIdentifier"></a><code>[virtual] </code><span class="type">int</span> QMouseDevice::<span class="name">buttonIdentifier</span>(const <span class="type">QString</span> &<i>name</i>) const</h3> <p>Reimplemented from <a href="qt3dinput-qabstractphysicaldevice.html#buttonIdentifier">QAbstractPhysicalDevice::buttonIdentifier</a>().</p> <p>Returns the button identifier that corresponds with the specified <i>name</i>. The possible return values are documented in <a href="qt3dinput-qmouseevent.html#Buttons-enum">QMouseEvent::Buttons</a>.</p> <!-- @@@buttonIdentifier --> <!-- $$$buttonNames[overload1]$$$buttonNames --> <h3 class="fn" id="buttonNames"><a name="buttonNames"></a><code>[virtual] </code><span class="type">QStringList</span> QMouseDevice::<span class="name">buttonNames</span>() const</h3> <p>Reimplemented from <a href="qt3dinput-qabstractphysicaldevice.html#buttonNames">QAbstractPhysicalDevice::buttonNames</a>().</p> <p>Returns the names of the buttons.</p> <p><b>Note: </b>Currently always returns StringList["Left", "Right", "Center"]</p><!-- @@@buttonNames --> </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>