Sophie

Sophie

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

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" />
<!-- qabstractcameracontroller.cpp -->
  <title>QAbstractCameraController 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 >QAbstractCameraController</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="#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="#signals">Signals</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#protected-functions">Protected Functions</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">QAbstractCameraController Class</h1>
<span class="small-subtitle">(<a href="qt3dextras-qabstractcameracontroller.html">Qt3DExtras::QAbstractCameraController</a>)<br/></span>
<!-- $$$QAbstractCameraController-brief -->
<p>The <a href="qt3dextras-qabstractcameracontroller.html">QAbstractCameraController</a> class provides basic functionality for camera controllers. <a href="#details">More...</a></p>
<!-- @@@QAbstractCameraController -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;QAbstractCameraController&gt;</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.10</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qt3dcore-qentity.html">Qt3DCore::QEntity</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qt3dextras-qfirstpersoncameracontroller.html">Qt3DExtras::QFirstPersonCameraController</a> and <a href="qt3dextras-qorbitcameracontroller.html">Qt3DExtras::QOrbitCameraController</a></p>
</td></tr></table></div><ul>
<li><a href="qt3dextras-qabstractcameracontroller-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"> class </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qabstractcameracontroller-inputstate.html">InputState</a></b></td></tr>
</table></div>
<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-qabstractcameracontroller.html#acceleration-prop">acceleration</a></b> : float</li>
<li class="fn"><b><a href="qt3dextras-qabstractcameracontroller.html#camera-prop">camera</a></b> : Qt3DRender::QCamera*</li>
<li class="fn"><b><a href="qt3dextras-qabstractcameracontroller.html#deceleration-prop">deceleration</a></b> : float</li>
</ul></td><td class="topAlign"><ul>
<li class="fn"><b><a href="qt3dextras-qabstractcameracontroller.html#linearSpeed-prop">linearSpeed</a></b> : float</li>
<li class="fn"><b><a href="qt3dextras-qabstractcameracontroller.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"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qabstractcameracontroller.html#dtor.QAbstractCameraController">~QAbstractCameraController</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> float </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qabstractcameracontroller.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-qabstractcameracontroller.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-qabstractcameracontroller.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-qabstractcameracontroller.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-qabstractcameracontroller.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-qabstractcameracontroller.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-qabstractcameracontroller.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-qabstractcameracontroller.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-qabstractcameracontroller.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-qabstractcameracontroller.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">13 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-qabstractcameracontroller.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-qabstractcameracontroller.html#camera-prop">cameraChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qabstractcameracontroller.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-qabstractcameracontroller.html#linearSpeed-prop">linearSpeedChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qabstractcameracontroller.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>
<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="qt3dextras-qabstractcameracontroller.html#staticMetaObject-var">staticMetaObject</a></b></td></tr>
</table></div>
<a name="protected-functions"></a>
<h2 id="protected-functions">Protected Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qabstractcameracontroller.html#QAbstractCameraController">QAbstractCameraController</a></b>(Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt3DInput::QKeyboardDevice *</td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qabstractcameracontroller.html#keyboardDevice">keyboardDevice</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt3DInput::QMouseDevice *</td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qabstractcameracontroller.html#mouseDevice">mouseDevice</a></b>() const</td></tr>
</table></div>
<ul>
<li class="fn">2 protected functions inherited from <a href="qt3dcore-qnode.html#protected-functions">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>
</ul>
<a name="details"></a>
<!-- $$$QAbstractCameraController-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qt3dextras-qabstractcameracontroller.html">QAbstractCameraController</a> class provides basic functionality for camera controllers.</p>
<p><a href="qt3dextras-qabstractcameracontroller.html">QAbstractCameraController</a> sets up and handles input from keyboard, mouse, and other devices. <a href="qt3dextras-qabstractcameracontroller.html">QAbstractCameraController</a> is an abstract class and cannot itself be instantiated. It provides a standard interface for camera controllers.</p>
<p>Derived classes need only implement the frameActionTriggered() method to move the camera.</p>
</div>
<!-- @@@QAbstractCameraController -->
<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"><a href="qt3drender-qcamera.html">Qt3DRender::QCamera</a></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>The default is <code>10.0</code>.</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>The default is <code>180.0</code>.</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>
<!-- $$$QAbstractCameraController[overload1]$$$QAbstractCameraControllerQt3DCore::QNode* -->
<h3 class="fn" id="QAbstractCameraController"><a name="QAbstractCameraController"></a><code>[protected] </code>QAbstractCameraController::<span class="name">QAbstractCameraController</span>(<span class="type"><a href="qt3dcore-qnode.html">Qt3DCore::QNode</a></span> *<i>parent</i> = nullptr)</h3>
<p>Default constructs an instance of QAbstractCameraController.</p><!-- @@@QAbstractCameraController -->
<!-- $$$~QAbstractCameraController[overload1]$$$~QAbstractCameraController -->
<h3 class="fn" id="dtor.QAbstractCameraController"><a name="dtor.QAbstractCameraController"></a><code>[virtual] </code>QAbstractCameraController::<span class="name">~QAbstractCameraController</span>()</h3>
<p>Destroys the instance of QAbstractCameraController. The destructor is virtual.</p><!-- @@@~QAbstractCameraController -->
<!-- $$$keyboardDevice[overload1]$$$keyboardDevice -->
<h3 class="fn" id="keyboardDevice"><a name="keyboardDevice"></a><code>[protected] </code><span class="type"><a href="qt3dinput-qkeyboarddevice.html">Qt3DInput::QKeyboardDevice</a></span> *QAbstractCameraController::<span class="name">keyboardDevice</span>() const</h3>
<p>Provides access to the keyboard device.</p>
<!-- @@@keyboardDevice -->
<!-- $$$mouseDevice[overload1]$$$mouseDevice -->
<h3 class="fn" id="mouseDevice"><a name="mouseDevice"></a><code>[protected] </code><span class="type"><a href="qt3dinput-qmousedevice.html">Qt3DInput::QMouseDevice</a></span> *QAbstractCameraController::<span class="name">mouseDevice</span>() const</h3>
<p>Provides access to the mouse device.</p>
<!-- @@@mouseDevice -->
</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>