<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- q3dinputhandler.cpp --> <title>Q3DInputHandler Class | Qt Data Visualization 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="qtdatavisualization-index.html">Qt Data Visualization</a></td><td ><a href="qtdatavisualization-module.html">C++ Classes</a></td><td >Q3DInputHandler</td></tr></table><table class="buildversion"><tr> <td id="buildversion" width="100%" align="right"><a href="qtdatavisualization-index.html">Qt Data Visualization | Commercial or GPLv3</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="#reimplemented-public-functions">Reimplemented Public Functions</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">Q3DInputHandler Class</h1> <!-- $$$Q3DInputHandler-brief --> <p>Basic wheel mouse based input handler. <a href="#details">More...</a></p> <!-- @@@Q3DInputHandler --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <Q3DInputHandler></span> </td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> QtDataVisualization 1.0</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiated By:</td><td class="memItemRight bottomAlign"> <a href="qml-qtdatavisualization-inputhandler3d.html">InputHandler3D</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qabstract3dinputhandler.html">QAbstract3DInputHandler</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qtouch3dinputhandler.html">QTouch3DInputHandler</a></p> </td></tr></table></div><ul> <li><a href="q3dinputhandler-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="q3dinputhandler.html#rotationEnabled-prop">rotationEnabled</a></b> : bool</li> <li class="fn"><b><a href="q3dinputhandler.html#selectionEnabled-prop">selectionEnabled</a></b> : bool</li> <li class="fn"><b><a href="q3dinputhandler.html#zoomAtTargetEnabled-prop">zoomAtTargetEnabled</a></b> : bool</li> <li class="fn"><b><a href="q3dinputhandler.html#zoomEnabled-prop">zoomEnabled</a></b> : bool</li> </ul> <ul> <li class="fn">3 properties inherited from <a href="qabstract3dinputhandler.html#properties">QAbstract3DInputHandler</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="q3dinputhandler.html#Q3DInputHandler">Q3DInputHandler</a></b>(QObject *<i>parent</i> = nullptr)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="q3dinputhandler.html#dtor.Q3DInputHandler">~Q3DInputHandler</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3dinputhandler.html#rotationEnabled-prop">isRotationEnabled</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3dinputhandler.html#selectionEnabled-prop">isSelectionEnabled</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3dinputhandler.html#zoomAtTargetEnabled-prop">isZoomAtTargetEnabled</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3dinputhandler.html#zoomEnabled-prop">isZoomEnabled</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3dinputhandler.html#rotationEnabled-prop">setRotationEnabled</a></b>(bool <i>enable</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3dinputhandler.html#selectionEnabled-prop">setSelectionEnabled</a></b>(bool <i>enable</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3dinputhandler.html#zoomAtTargetEnabled-prop">setZoomAtTargetEnabled</a></b>(bool <i>enable</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3dinputhandler.html#zoomEnabled-prop">setZoomEnabled</a></b>(bool <i>enable</i>)</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 void </td><td class="memItemRight bottomAlign"><b><a href="q3dinputhandler.html#mouseMoveEvent">mouseMoveEvent</a></b>(QMouseEvent *<i>event</i>, const QPoint &<i>mousePos</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3dinputhandler.html#mousePressEvent">mousePressEvent</a></b>(QMouseEvent *<i>event</i>, const QPoint &<i>mousePos</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3dinputhandler.html#mouseReleaseEvent">mouseReleaseEvent</a></b>(QMouseEvent *<i>event</i>, const QPoint &<i>mousePos</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3dinputhandler.html#wheelEvent">wheelEvent</a></b>(QWheelEvent *<i>event</i>)</td></tr> </table></div> <ul> <li class="fn">12 public functions inherited from <a href="qabstract3dinputhandler.html#public-functions">QAbstract3DInputHandler</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="q3dinputhandler.html#rotationEnabled-prop">rotationEnabledChanged</a></b>(bool <i>enable</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3dinputhandler.html#selectionEnabled-prop">selectionEnabledChanged</a></b>(bool <i>enable</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3dinputhandler.html#zoomAtTargetEnabled-prop">zoomAtTargetEnabledChanged</a></b>(bool <i>enable</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3dinputhandler.html#zoomEnabled-prop">zoomEnabledChanged</a></b>(bool <i>enable</i>)</td></tr> </table></div> <ul> <li class="fn">3 signals inherited from <a href="qabstract3dinputhandler.html#signals">QAbstract3DInputHandler</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="q3dinputhandler.html#staticMetaObject-var">staticMetaObject</a></b></td></tr> </table></div> <h3>Additional Inherited Members</h3> <ul> <li class="fn">4 protected functions inherited from <a href="qabstract3dinputhandler.html#protected-functions">QAbstract3DInputHandler</a></li> </ul> <a name="details"></a> <!-- $$$Q3DInputHandler-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>Basic wheel mouse based input handler.</p> <p><a href="q3dinputhandler.html">Q3DInputHandler</a> is the basic input handler for wheel mouse type of input devices.</p> <p>Default input handler has the following functionalty:</p> <div class="table"><table class="generic"> <thead><tr class="qt-style"><th >Mouse action</th><th >Action</th></tr></thead> <tr valign="top" class="odd"><td >Drag with right button pressed</td><td >Rotate graph within limits set for <a href="q3dcamera.html">Q3DCamera</a>.</td></tr> <tr valign="top" class="even"><td >Left click</td><td >Select item under cursor or remove selection if none. May open the secondary view depending on the <a href="qabstract3dgraph.html#selectionMode-prop">selection mode</a>.</td></tr> <tr valign="top" class="odd"><td >Mouse wheel</td><td >Zoom in/out within the allowable zoom range set for <a href="q3dcamera.html">Q3DCamera</a>.</td></tr> <tr valign="top" class="even"><td >Left click on the primary view when the secondary view is visible</td><td >Closes the secondary view.<p><b>Note: </b>Secondary view is available only for <a href="q3dbars.html">Q3DBars</a> and <a href="q3dsurface.html">Q3DSurface</a> graphs.</p></td></tr> </table></div> <p>Rotation, zoom, and selection can each be individually disabled using corresponding properties of this class.</p> </div> <!-- @@@Q3DInputHandler --> <div class="prop"> <h2>Property Documentation</h2> <!-- $$$rotationEnabled-prop$$$isRotationEnabled$$$setRotationEnabledbool$$$rotationEnabledChangedbool --> <h3 class="fn" id="rotationEnabled-prop"><a name="rotationEnabled-prop"></a><span class="name">rotationEnabled</span> : <span class="type">bool</span></h3> <p>This property holds whether this input handler allows graph rotation.</p> <p>Defaults to <code>true</code>.</p> <p>This property was introduced in QtDataVisualization 1.2.</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>isRotationEnabled</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setRotationEnabled</b></span>(bool <i>enable</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>rotationEnabledChanged</b></span>(bool <i>enable</i>)</td></tr> </table></div> <!-- @@@rotationEnabled --> <!-- $$$selectionEnabled-prop$$$isSelectionEnabled$$$setSelectionEnabledbool$$$selectionEnabledChangedbool --> <h3 class="fn" id="selectionEnabled-prop"><a name="selectionEnabled-prop"></a><span class="name">selectionEnabled</span> : <span class="type">bool</span></h3> <p>This property holds whether this input handler allows selection from the graph.</p> <p>Defaults to <code>true</code>.</p> <p>This property was introduced in QtDataVisualization 1.2.</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>isSelectionEnabled</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setSelectionEnabled</b></span>(bool <i>enable</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>selectionEnabledChanged</b></span>(bool <i>enable</i>)</td></tr> </table></div> <!-- @@@selectionEnabled --> <!-- $$$zoomAtTargetEnabled-prop$$$isZoomAtTargetEnabled$$$setZoomAtTargetEnabledbool$$$zoomAtTargetEnabledChangedbool --> <h3 class="fn" id="zoomAtTargetEnabled-prop"><a name="zoomAtTargetEnabled-prop"></a><span class="name">zoomAtTargetEnabled</span> : <span class="type">bool</span></h3> <p>This property holds whether zooming should change the camera target so that the zoomed point of the graph stays at the same location after the zoom.</p> <p>Defaults to <code>true</code>.</p> <p>This property was introduced in QtDataVisualization 1.2.</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>isZoomAtTargetEnabled</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setZoomAtTargetEnabled</b></span>(bool <i>enable</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>zoomAtTargetEnabledChanged</b></span>(bool <i>enable</i>)</td></tr> </table></div> <!-- @@@zoomAtTargetEnabled --> <!-- $$$zoomEnabled-prop$$$isZoomEnabled$$$setZoomEnabledbool$$$zoomEnabledChangedbool --> <h3 class="fn" id="zoomEnabled-prop"><a name="zoomEnabled-prop"></a><span class="name">zoomEnabled</span> : <span class="type">bool</span></h3> <p>This property holds whether this input handler allows graph zooming.</p> <p>Defaults to <code>true</code>.</p> <p>This property was introduced in QtDataVisualization 1.2.</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>isZoomEnabled</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setZoomEnabled</b></span>(bool <i>enable</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>zoomEnabledChanged</b></span>(bool <i>enable</i>)</td></tr> </table></div> <!-- @@@zoomEnabled --> </div> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$Q3DInputHandler[overload1]$$$Q3DInputHandlerQObject* --> <h3 class="fn" id="Q3DInputHandler"><a name="Q3DInputHandler"></a>Q3DInputHandler::<span class="name">Q3DInputHandler</span>(<span class="type">QObject</span> *<i>parent</i> = nullptr)</h3> <p>Constructs the basic mouse input handler. An optional <i>parent</i> parameter can be given and is then passed to QObject constructor.</p> <!-- @@@Q3DInputHandler --> <!-- $$$~Q3DInputHandler[overload1]$$$~Q3DInputHandler --> <h3 class="fn" id="dtor.Q3DInputHandler"><a name="dtor.Q3DInputHandler"></a><code>[virtual] </code>Q3DInputHandler::<span class="name">~Q3DInputHandler</span>()</h3> <p>Destroys the input handler.</p> <!-- @@@~Q3DInputHandler --> <!-- $$$mouseMoveEvent[overload1]$$$mouseMoveEventQMouseEvent*constQPoint& --> <h3 class="fn" id="mouseMoveEvent"><a name="mouseMoveEvent"></a><code>[virtual] </code><span class="type">void</span> Q3DInputHandler::<span class="name">mouseMoveEvent</span>(<span class="type">QMouseEvent</span> *<i>event</i>, const <span class="type">QPoint</span> &<i>mousePos</i>)</h3> <p>Reimplemented from <a href="qabstract3dinputhandler.html#mouseMoveEvent">QAbstract3DInputHandler::mouseMoveEvent</a>().</p> <p>Override this to change handling of mouse move events. Mouse move event is given in the <i>event</i> and the mouse position in <i>mousePos</i>.</p> <!-- @@@mouseMoveEvent --> <!-- $$$mousePressEvent[overload1]$$$mousePressEventQMouseEvent*constQPoint& --> <h3 class="fn" id="mousePressEvent"><a name="mousePressEvent"></a><code>[virtual] </code><span class="type">void</span> Q3DInputHandler::<span class="name">mousePressEvent</span>(<span class="type">QMouseEvent</span> *<i>event</i>, const <span class="type">QPoint</span> &<i>mousePos</i>)</h3> <p>Reimplemented from <a href="qabstract3dinputhandler.html#mousePressEvent">QAbstract3DInputHandler::mousePressEvent</a>().</p> <p>Override this to change handling of mouse press events. Mouse press event is given in the <i>event</i> and the mouse position in <i>mousePos</i>.</p> <!-- @@@mousePressEvent --> <!-- $$$mouseReleaseEvent[overload1]$$$mouseReleaseEventQMouseEvent*constQPoint& --> <h3 class="fn" id="mouseReleaseEvent"><a name="mouseReleaseEvent"></a><code>[virtual] </code><span class="type">void</span> Q3DInputHandler::<span class="name">mouseReleaseEvent</span>(<span class="type">QMouseEvent</span> *<i>event</i>, const <span class="type">QPoint</span> &<i>mousePos</i>)</h3> <p>Reimplemented from <a href="qabstract3dinputhandler.html#mouseReleaseEvent">QAbstract3DInputHandler::mouseReleaseEvent</a>().</p> <p>Override this to change handling of mouse release events. Mouse release event is given in the <i>event</i> and the mouse position in <i>mousePos</i>.</p> <!-- @@@mouseReleaseEvent --> <!-- $$$wheelEvent[overload1]$$$wheelEventQWheelEvent* --> <h3 class="fn" id="wheelEvent"><a name="wheelEvent"></a><code>[virtual] </code><span class="type">void</span> Q3DInputHandler::<span class="name">wheelEvent</span>(<span class="type">QWheelEvent</span> *<i>event</i>)</h3> <p>Reimplemented from <a href="qabstract3dinputhandler.html#wheelEvent">QAbstract3DInputHandler::wheelEvent</a>().</p> <p>Override this to change handling of wheel events. The wheel event is given in the <i>event</i>.</p> <!-- @@@wheelEvent --> </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>