<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qt3dinput-module.qdoc -->
<title>Qt3DInput Namespace | 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 >Qt3DInput Namespace</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="#classes">Classes</a></li>
<li class="level1"><a href="#types">Types</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">Qt3DInput Namespace</h1>
<!-- $$$Qt3DInput-brief -->
<p>Contains classes that enable user input. <a href="#details">More...</a></p>
<!-- @@@Qt3DInput -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <Qt3DInput></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += 3dinput</td></tr></table></div><ul>
</ul>
<a name="classes"></a>
<h2 id="classes">Classes</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qabstractactioninput.html">QAbstractActionInput</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qabstractaxisinput.html">QAbstractAxisInput</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qabstractphysicaldevice.html">QAbstractPhysicalDevice</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qaction.html">QAction</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qactioninput.html">QActionInput</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qanalogaxisinput.html">QAnalogAxisInput</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qaxis.html">QAxis</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qaxisaccumulator.html">QAxisAccumulator</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qaxissetting.html">QAxisSetting</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qbuttonaxisinput.html">QButtonAxisInput</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qinputaspect.html">QInputAspect</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qinputchord.html">QInputChord</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qinputsequence.html">QInputSequence</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qinputsettings.html">QInputSettings</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qkeyevent.html">QKeyEvent</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qkeyboarddevice.html">QKeyboardDevice</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qkeyboardhandler.html">QKeyboardHandler</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qlogicaldevice.html">QLogicalDevice</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmousedevice.html">QMouseDevice</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmouseevent.html">QMouseEvent</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmousehandler.html">QMouseHandler</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qphysicaldevicecreatedchange.html">QPhysicalDeviceCreatedChange</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qphysicaldevicecreatedchangebase.html">QPhysicalDeviceCreatedChangeBase</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qwheelevent.html">QWheelEvent</a></b></td></tr>
</table></div>
<a name="types"></a>
<h2 id="types">Types</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> typedef </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qkeyevent.html#QKeyEventPtr-typedef">QKeyEventPtr</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> typedef </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmouseevent.html#QMouseEventPtr-typedef">QMouseEventPtr</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> typedef </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput.html#QPhysicalDeviceCreatedChangeBasePtr-typedef">QPhysicalDeviceCreatedChangeBasePtr</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> typedef </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qwheelevent.html#QWheelEventPtr-typedef">QWheelEventPtr</a></b></td></tr>
</table></div>
<a name="details"></a>
<!-- $$$Qt3DInput-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>Contains classes that enable user input.</p>
</div>
<!-- @@@Qt3DInput -->
<div class="classes">
<h2>Classes</h2>
<h3> class <a href="qt3dinput-qabstractactioninput.html">QAbstractActionInput</a></h3><!-- $$$QAbstractActionInput-brief -->
<p><a href="qt3dinput-qabstractactioninput.html">QAbstractActionInput</a> is the base class for the Action Input and all Aggregate Action Inputs. <a href="qt3dinput-qabstractactioninput.html#details">More...</a></p>
<!-- @@@QAbstractActionInput -->
<h3> class <a href="qt3dinput-qabstractaxisinput.html">QAbstractAxisInput</a></h3><!-- $$$QAbstractAxisInput-brief -->
<p><a href="qt3dinput-qabstractactioninput.html">QAbstractActionInput</a> is the base class for all Axis Input. <a href="qt3dinput-qabstractaxisinput.html#details">More...</a></p>
<!-- @@@QAbstractAxisInput -->
<h3> class <a href="qt3dinput-qabstractphysicaldevice.html">QAbstractPhysicalDevice</a></h3><!-- $$$QAbstractPhysicalDevice-brief -->
<p><a href="qt3dinput-qabstractphysicaldevice.html">QAbstractPhysicalDevice</a> is the base class used by Qt3d to interact with arbitrary input devices. <a href="qt3dinput-qabstractphysicaldevice.html#details">More...</a></p>
<!-- @@@QAbstractPhysicalDevice -->
<h3> class <a href="qt3dinput-qaction.html">QAction</a></h3><!-- $$$QAction-brief -->
<p>Links a set of <a href="qt3dinput-qabstractactioninput.html">QAbstractActionInput</a> that trigger the same event. <a href="qt3dinput-qaction.html#details">More...</a></p>
<!-- @@@QAction -->
<h3> class <a href="qt3dinput-qactioninput.html">QActionInput</a></h3><!-- $$$QActionInput-brief -->
<p><a href="qt3dinput-qactioninput.html">QActionInput</a> stores Device and Buttons used to trigger an input event. <a href="qt3dinput-qactioninput.html#details">More...</a></p>
<!-- @@@QActionInput -->
<h3> class <a href="qt3dinput-qanalogaxisinput.html">QAnalogAxisInput</a></h3><!-- $$$QAnalogAxisInput-brief -->
<p>An axis input controlled by an analog input The axis value is controlled like a traditional analog input such as a joystick. <a href="qt3dinput-qanalogaxisinput.html#details">More...</a></p>
<!-- @@@QAnalogAxisInput -->
<h3> class <a href="qt3dinput-qaxis.html">QAxis</a></h3><!-- $$$QAxis-brief -->
<p><a href="qt3dinput-qaxis.html">QAxis</a> stores QAbstractAxisInputs used to trigger an input event. <a href="qt3dinput-qaxis.html#details">More...</a></p>
<!-- @@@QAxis -->
<h3> class <a href="qt3dinput-qaxisaccumulator.html">QAxisAccumulator</a></h3><!-- $$$QAxisAccumulator-brief -->
<p><a href="qt3dinput-qaxisaccumulator.html">QAxisAccumulator</a> processes velocity or acceleration data from a <a href="qt3dinput-qaxis.html">QAxis</a>. <a href="qt3dinput-qaxisaccumulator.html#details">More...</a></p>
<!-- @@@QAxisAccumulator -->
<h3> class <a href="qt3dinput-qaxissetting.html">QAxisSetting</a></h3><!-- $$$QAxisSetting-brief -->
<p><a href="qt3dinput-qaxissetting.html">QAxisSetting</a> stores settings for the specified list of Axis. <a href="qt3dinput-qaxissetting.html#details">More...</a></p>
<!-- @@@QAxisSetting -->
<h3> class <a href="qt3dinput-qbuttonaxisinput.html">QButtonAxisInput</a></h3><!-- $$$QButtonAxisInput-brief -->
<p>An axis input controlled by buttons The axis value is controlled by buttons rather than a traditional analog input such as a joystick. <a href="qt3dinput-qbuttonaxisinput.html#details">More...</a></p>
<!-- @@@QButtonAxisInput -->
<h3> class <a href="qt3dinput-qinputaspect.html">QInputAspect</a></h3><!-- $$$QInputAspect-brief -->
<p>Responsible for creating physical devices and handling associated jobs. <a href="qt3dinput-qinputaspect.html#details">More...</a></p>
<!-- @@@QInputAspect -->
<h3> class <a href="qt3dinput-qinputchord.html">QInputChord</a></h3><!-- $$$QInputChord-brief -->
<p><a href="qt3dinput-qinputchord.html">QInputChord</a> represents a set of <a href="qt3dinput-qabstractactioninput.html">QAbstractActionInput</a>'s that must be triggerd at once. <a href="qt3dinput-qinputchord.html#details">More...</a></p>
<!-- @@@QInputChord -->
<h3> class <a href="qt3dinput-qinputsequence.html">QInputSequence</a></h3><!-- $$$QInputSequence-brief -->
<p><a href="qt3dinput-qinputsequence.html">QInputSequence</a> represents a set of <a href="qt3dinput-qabstractactioninput.html">QAbstractActionInput</a>'s that must be triggerd one after the other. <a href="qt3dinput-qinputsequence.html#details">More...</a></p>
<!-- @@@QInputSequence -->
<h3> class <a href="qt3dinput-qinputsettings.html">QInputSettings</a></h3><!-- $$$QInputSettings-brief -->
<p><a href="qt3dinput-qinputsettings.html">QInputSettings</a> class holds the pointer to an input event source object. <a href="qt3dinput-qinputsettings.html#details">More...</a></p>
<!-- @@@QInputSettings -->
<h3> class <a href="qt3dinput-qkeyevent.html">QKeyEvent</a></h3><!-- $$$QKeyEvent-brief -->
<p><a href="qt3dinput-qkeyevent.html">QKeyEvent</a> event type send by KeyBoardHandler. <a href="qt3dinput-qkeyevent.html#details">More...</a></p>
<!-- @@@QKeyEvent -->
<h3> class <a href="qt3dinput-qkeyboarddevice.html">QKeyboardDevice</a></h3><!-- $$$QKeyboardDevice-brief -->
<p><a href="qt3dinput-qkeyboarddevice.html">QKeyboardDevice</a> is in charge of dispatching keyboard events to attached QQKeyboardHandler objects. <a href="qt3dinput-qkeyboarddevice.html#details">More...</a></p>
<!-- @@@QKeyboardDevice -->
<h3> class <a href="qt3dinput-qkeyboardhandler.html">QKeyboardHandler</a></h3><!-- $$$QKeyboardHandler-brief -->
<p>Provides keyboard event notification <a href="qt3dinput-qkeyboardhandler.html#details">More...</a></p>
<!-- @@@QKeyboardHandler -->
<h3> class <a href="qt3dinput-qlogicaldevice.html">QLogicalDevice</a></h3><!-- $$$QLogicalDevice-brief -->
<p><a href="qt3dinput-qlogicaldevice.html">QLogicalDevice</a> allows the user to define a set of actions that they wish to use within an application. <a href="qt3dinput-qlogicaldevice.html#details">More...</a></p>
<!-- @@@QLogicalDevice -->
<h3> class <a href="qt3dinput-qmousedevice.html">QMouseDevice</a></h3><!-- $$$QMouseDevice-brief -->
<p>Delegates mouse events to the attached <a href="qml-qt3d-input-mousehandler.html">MouseHandler</a> objects. <a href="qt3dinput-qmousedevice.html#details">More...</a></p>
<!-- @@@QMouseDevice -->
<h3> class <a href="qt3dinput-qmouseevent.html">QMouseEvent</a></h3><!-- $$$QMouseEvent-brief -->
<p>The Qt3DCore::QMouseEvent contains parameters that describe a mouse event. <a href="qt3dinput-qmouseevent.html#details">More...</a></p>
<!-- @@@QMouseEvent -->
<h3> class <a href="qt3dinput-qmousehandler.html">QMouseHandler</a></h3><!-- $$$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="qt3dinput-qmousehandler.html#details">More...</a></p>
<!-- @@@QMouseHandler -->
<h3> class <a href="qt3dinput-qphysicaldevicecreatedchange.html">QPhysicalDeviceCreatedChange</a></h3><h3> class <a href="qt3dinput-qphysicaldevicecreatedchangebase.html">QPhysicalDeviceCreatedChangeBase</a></h3><h3> class <a href="qt3dinput-qwheelevent.html">QWheelEvent</a></h3><!-- $$$QWheelEvent-brief -->
<p>The <a href="qt3dinput-qwheelevent.html">QWheelEvent</a> class contains parameters that describe a mouse wheel event. <a href="qt3dinput-qwheelevent.html#details">More...</a></p>
<!-- @@@QWheelEvent -->
</div>
<div class="types">
<h2>Type Documentation</h2>
<!-- $$$QKeyEventPtr -->
<h3 class="fn" id="QKeyEventPtr-typedef"><a name="QKeyEventPtr-typedef"></a>typedef Qt3DInput::<span class="name">QKeyEventPtr</span></h3>
<p>A shared pointer for <a href="qt3dinput-qkeyevent.html">QKeyEvent</a>.</p>
<!-- @@@QKeyEventPtr -->
<!-- $$$QMouseEventPtr -->
<h3 class="fn" id="QMouseEventPtr-typedef"><a name="QMouseEventPtr-typedef"></a>typedef Qt3DInput::<span class="name">QMouseEventPtr</span></h3>
<p>A shared pointer for <a href="qt3dinput-qmouseevent.html">QMouseEvent</a>.</p>
<!-- @@@QMouseEventPtr -->
<!-- $$$QPhysicalDeviceCreatedChangeBasePtr -->
<h3 class="fn" id="QPhysicalDeviceCreatedChangeBasePtr-typedef"><a name="QPhysicalDeviceCreatedChangeBasePtr-typedef"></a>typedef Qt3DInput::<span class="name">QPhysicalDeviceCreatedChangeBasePtr</span></h3>
<!-- @@@QPhysicalDeviceCreatedChangeBasePtr -->
<!-- $$$QWheelEventPtr -->
<h3 class="fn" id="QWheelEventPtr-typedef"><a name="QWheelEventPtr-typedef"></a>typedef Qt3DInput::<span class="name">QWheelEventPtr</span></h3>
<p>A shared pointer for <a href="qt3dinput-qwheelevent.html">QWheelEvent</a>.</p>
<!-- @@@QWheelEventPtr -->
</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>
