<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qorbitcameracontroller.cpp --> <title>QOrbitCameraController 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 >QOrbitCameraController</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">QOrbitCameraController Class</h1> <span class="small-subtitle">(<a href="qt3dextras-qorbitcameracontroller.html">Qt3DExtras::QOrbitCameraController</a>)<br/></span> <!-- $$$QOrbitCameraController-brief --> <p>The <a href="qt3dextras-qorbitcameracontroller.html">QOrbitCameraController</a> class allows controlling the scene camera along orbital path. <a href="#details">More...</a></p> <!-- @@@QOrbitCameraController --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QOrbitCameraController></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-qorbitcameracontroller-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="qt3dextras-qorbitcameracontroller.html#camera-prop">camera</a></b> : Qt3DRender::QCamera *</li> <li class="fn"><b><a href="qt3dextras-qorbitcameracontroller.html#linearSpeed-prop">linearSpeed</a></b> : float</li> <li class="fn"><b><a href="qt3dextras-qorbitcameracontroller.html#lookSpeed-prop">lookSpeed</a></b> : float</li> <li class="fn"><b><a href="qt3dextras-qorbitcameracontroller.html#zoomInLimit-prop">zoomInLimit</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="qt3dextras-qorbitcameracontroller.html#QOrbitCameraController">QOrbitCameraController</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-qorbitcameracontroller.html#dtor.QOrbitCameraController">~QOrbitCameraController</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> Qt3DRender::QCamera *</td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qorbitcameracontroller.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-qorbitcameracontroller.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-qorbitcameracontroller.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-qorbitcameracontroller.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-qorbitcameracontroller.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-qorbitcameracontroller.html#lookSpeed-prop">setLookSpeed</a></b>(float <i>lookSpeed</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qorbitcameracontroller.html#zoomInLimit-prop">setZoomInLimit</a></b>(float <i>zoomInLimit</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> float </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qorbitcameracontroller.html#zoomInLimit-prop">zoomInLimit</a></b>() const</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-qorbitcameracontroller.html#camera-prop">cameraChanged</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qorbitcameracontroller.html#linearSpeed-prop">linearSpeedChanged</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qorbitcameracontroller.html#lookSpeed-prop">lookSpeedChanged</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dextras-qorbitcameracontroller.html#zoomInLimit-prop">zoomInLimitChanged</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> <!-- $$$QOrbitCameraController-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>The <a href="qt3dextras-qorbitcameracontroller.html">QOrbitCameraController</a> class allows controlling the scene camera along orbital path.</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 moves the camera left and right and movement along y-axis moves it up and down.</td></tr> <tr valign="top" class="even"><td >Right mouse button</td><td >While the right mouse button is pressed, mouse movement along x-axis pans the camera around the camera view center and movement along y-axis tilts it around the camera view center.</td></tr> <tr valign="top" class="odd"><td >Both left and right mouse button</td><td >While both the left and the right mouse button are pressed, mouse movement along y-axis zooms the camera in and out without changing the view center.</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 >Arrow keys</td><td >Move the camera vertically and horizontally relative to camera viewport.</td></tr> <tr valign="top" class="even"><td >Page up and page down keys</td><td >Move the camera forwards and backwards.</td></tr> <tr valign="top" class="odd"><td >Shift key</td><td >Changes the behavior of the up and down arrow keys to zoom the camera in and out without changing the view center. The other movement keys are disabled.</td></tr> <tr valign="top" class="even"><td >Alt key</td><td >Changes the behovior of the arrow keys to pan and tilt the camera around the view center. Disables the page up and page down keys.</td></tr> </table></div> </div> <!-- @@@QOrbitCameraController --> <div class="prop"> <h2>Property Documentation</h2> <!-- $$$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 --> <!-- $$$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 --> <!-- $$$zoomInLimit-prop$$$zoomInLimit$$$setZoomInLimitfloat$$$zoomInLimitChanged --> <h3 class="fn" id="zoomInLimit-prop"><a name="zoomInLimit-prop"></a><span class="name">zoomInLimit</span> : <span class="type">float</span></h3> <p>Holds the current zoom-in limit. The zoom-in limit determines how close to the view center the camera can be zoomed.</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>zoomInLimit</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setZoomInLimit</b></span>(float <i>zoomInLimit</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>zoomInLimitChanged</b></span>()</td></tr> </table></div> <!-- @@@zoomInLimit --> </div> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QOrbitCameraController[overload1]$$$QOrbitCameraControllerQt3DCore::QNode* --> <h3 class="fn" id="QOrbitCameraController"><a name="QOrbitCameraController"></a>QOrbitCameraController::<span class="name">QOrbitCameraController</span>(<span class="type">Qt3DCore::QNode</span> *<i>parent</i> = nullptr)</h3> <p>Default constructs an instance of QOrbitCameraController.</p><!-- @@@QOrbitCameraController --> <!-- $$$~QOrbitCameraController[overload1]$$$~QOrbitCameraController --> <h3 class="fn" id="dtor.QOrbitCameraController"><a name="dtor.QOrbitCameraController"></a>QOrbitCameraController::<span class="name">~QOrbitCameraController</span>()</h3> <p>Destroys the instance of QOrbitCameraController.</p><!-- @@@~QOrbitCameraController --> </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>