<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qfirstpersoncameracontroller.cpp -->
<title>QFirstPersonCameraController 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 >QFirstPersonCameraController</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="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">Public Functions</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">QFirstPersonCameraController Class</h1>
<span class="small-subtitle">(<a href="qt3dextras-qfirstpersoncameracontroller.html">Qt3DExtras::QFirstPersonCameraController</a>)<br/></span>
<!-- $$$QFirstPersonCameraController-brief -->
<p>The <a href="qt3dextras-qfirstpersoncameracontroller.html">QFirstPersonCameraController</a> class allows controlling the scene camera from the first person perspective. <a href="#details">More...</a></p>
<!-- @@@QFirstPersonCameraController -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QFirstPersonCameraController></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += 3dextras</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.7</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qt3dcore-qentity.html">Qt3DCore::QEntity</a></td></tr></table></div><ul>
<li><a href="qt3dextras-qfirstpersoncameracontroller-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<div class="table"><table class="propsummary">
<tr><td class="topAlign"><ul>
<li class="fn"><b><a href="qt3dextras-qfirstpersoncameracontroller.html#acceleration-prop">acceleration</a></b> : float</li>
<li class="fn"><b><a href="qt3dextras-qfirstpersoncameracontroller.html#camera-prop">camera</a></b> : Qt3DRender::QCamera *</li>
<li class="fn"><b><a href="qt3dextras-qfirstpersoncameracontroller.html#deceleration-prop">deceleration</a></b> : float</li>
</ul></td><td class="topAlign"><ul>
<li class="fn"><b><a href="qt3dextras-qfirstpersoncameracontroller.html#linearSpeed-prop">linearSpeed</a></b> : float</li>
<li class="fn"><b><a href="qt3dextras-qfirstpersoncameracontroller.html#lookSpeed-prop">lookSpeed</a></b> : float</li>
</ul>
</td></tr>
</table></div>
<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="qt3dextras-qfirstpersoncameracontroller.html#QFirstPersonCameraController">QFirstPersonCameraController</a></b>(Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qfirstpersoncameracontroller.html#dtor.QFirstPersonCameraController">~QFirstPersonCameraController</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> float </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qfirstpersoncameracontroller.html#acceleration-prop">acceleration</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt3DRender::QCamera *</td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qfirstpersoncameracontroller.html#camera-prop">camera</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> float </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qfirstpersoncameracontroller.html#deceleration-prop">deceleration</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> float </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qfirstpersoncameracontroller.html#linearSpeed-prop">linearSpeed</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> float </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qfirstpersoncameracontroller.html#lookSpeed-prop">lookSpeed</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qfirstpersoncameracontroller.html#acceleration-prop">setAcceleration</a></b>(float <i>acceleration</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qfirstpersoncameracontroller.html#camera-prop">setCamera</a></b>(Qt3DRender::QCamera *<i>camera</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qfirstpersoncameracontroller.html#deceleration-prop">setDeceleration</a></b>(float <i>deceleration</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qfirstpersoncameracontroller.html#linearSpeed-prop">setLinearSpeed</a></b>(float <i>linearSpeed</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qfirstpersoncameracontroller.html#lookSpeed-prop">setLookSpeed</a></b>(float <i>lookSpeed</i>)</td></tr>
</table></div>
<ul>
<li class="fn">4 public functions inherited from <a href="qt3dcore-qentity.html#public-functions">Qt3DCore::QEntity</a></li>
<li class="fn">11 public functions inherited from <a href="qt3dcore-qnode.html#public-functions">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="qt3dextras-qfirstpersoncameracontroller.html#acceleration-prop">accelerationChanged</a></b>(float <i>acceleration</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qfirstpersoncameracontroller.html#camera-prop">cameraChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qfirstpersoncameracontroller.html#deceleration-prop">decelerationChanged</a></b>(float <i>deceleration</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qfirstpersoncameracontroller.html#linearSpeed-prop">linearSpeedChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qfirstpersoncameracontroller.html#lookSpeed-prop">lookSpeedChanged</a></b>()</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">3 public slots inherited from <a href="qt3dcore-qnode.html#public-slots">Qt3DCore::QNode</a></li>
<li class="fn">2 protected functions inherited from <a href="qt3dcore-qnode.html#protected-functions">Qt3DCore::QNode</a></li>
</ul>
<a name="details"></a>
<!-- $$$QFirstPersonCameraController-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qt3dextras-qfirstpersoncameracontroller.html">QFirstPersonCameraController</a> class allows controlling the scene camera from the first person perspective.</p>
<p>The controls are:</p>
<div class="table"><table class="generic">
<thead><tr class="qt-style"><th >Input</th><th >Action</th></tr></thead>
<tr valign="top" class="odd"><td >Left mouse button</td><td >While the left mouse button is pressed, mouse movement along x-axis pans the camera and movement along y-axis tilts it.</td></tr>
<tr valign="top" class="even"><td >Mouse scroll wheel</td><td >Zooms the camera in and out without changing the view center.</td></tr>
<tr valign="top" class="odd"><td >Shift key</td><td >Turns the fine motion control active while pressed. Makes mouse pan and tilt less sensitive.</td></tr>
<tr valign="top" class="even"><td >Arrow keys</td><td >Move the camera horizontally relative to camera viewport.</td></tr>
<tr valign="top" class="odd"><td >Page up and page down keys</td><td >Move the camera vertically relative to camera viewport.</td></tr>
</table></div>
</div>
<!-- @@@QFirstPersonCameraController -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$acceleration-prop$$$acceleration$$$setAccelerationfloat$$$accelerationChangedfloat -->
<h3 class="fn" id="acceleration-prop"><a name="acceleration-prop"></a><span class="name">acceleration</span> : <span class="type">float</span></h3>
<p>Holds the current acceleration of the camera controller.</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>acceleration</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setAcceleration</b></span>(float <i>acceleration</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>accelerationChanged</b></span>(float <i>acceleration</i>)</td></tr>
</table></div>
<!-- @@@acceleration -->
<!-- $$$camera-prop$$$camera$$$setCameraQt3DRender::QCamera*$$$cameraChanged -->
<h3 class="fn" id="camera-prop"><a name="camera-prop"></a><span class="name">camera</span> : <span class="type">Qt3DRender::QCamera</span> *</h3>
<p>Holds the currently controlled camera.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> Qt3DRender::QCamera *</td><td class="memItemRight bottomAlign"><span class="name"><b>camera</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setCamera</b></span>(Qt3DRender::QCamera *<i>camera</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>cameraChanged</b></span>()</td></tr>
</table></div>
<!-- @@@camera -->
<!-- $$$deceleration-prop$$$deceleration$$$setDecelerationfloat$$$decelerationChangedfloat -->
<h3 class="fn" id="deceleration-prop"><a name="deceleration-prop"></a><span class="name">deceleration</span> : <span class="type">float</span></h3>
<p>Holds the current deceleration of the camera controller.</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>deceleration</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setDeceleration</b></span>(float <i>deceleration</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>decelerationChanged</b></span>(float <i>deceleration</i>)</td></tr>
</table></div>
<!-- @@@deceleration -->
<!-- $$$linearSpeed-prop$$$linearSpeed$$$setLinearSpeedfloat$$$linearSpeedChanged -->
<h3 class="fn" id="linearSpeed-prop"><a name="linearSpeed-prop"></a><span class="name">linearSpeed</span> : <span class="type">float</span></h3>
<p>Holds the current linear speed of the camera controller. Linear speed determines the movement speed of the camera.</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>linearSpeed</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setLinearSpeed</b></span>(float <i>linearSpeed</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>linearSpeedChanged</b></span>()</td></tr>
</table></div>
<!-- @@@linearSpeed -->
<!-- $$$lookSpeed-prop$$$lookSpeed$$$setLookSpeedfloat$$$lookSpeedChanged -->
<h3 class="fn" id="lookSpeed-prop"><a name="lookSpeed-prop"></a><span class="name">lookSpeed</span> : <span class="type">float</span></h3>
<p>Holds the current look speed of the camera controller. The look speed determines the turn rate of the camera pan and tilt.</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>lookSpeed</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setLookSpeed</b></span>(float <i>lookSpeed</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>lookSpeedChanged</b></span>()</td></tr>
</table></div>
<!-- @@@lookSpeed -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QFirstPersonCameraController[overload1]$$$QFirstPersonCameraControllerQt3DCore::QNode* -->
<h3 class="fn" id="QFirstPersonCameraController"><a name="QFirstPersonCameraController"></a>QFirstPersonCameraController::<span class="name">QFirstPersonCameraController</span>(<span class="type">Qt3DCore::QNode</span> *<i>parent</i> = nullptr)</h3>
<p>Default constructs an instance of QFirstPersonCameraController.</p><!-- @@@QFirstPersonCameraController -->
<!-- $$$~QFirstPersonCameraController[overload1]$$$~QFirstPersonCameraController -->
<h3 class="fn" id="dtor.QFirstPersonCameraController"><a name="dtor.QFirstPersonCameraController"></a>QFirstPersonCameraController::<span class="name">~QFirstPersonCameraController</span>()</h3>
<p>Destroys the instance of QFirstPersonCameraController.</p><!-- @@@~QFirstPersonCameraController -->
</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>
