QGIS API Documentation 3.43.0-Master (a93bf8b6462)
qgscameracontroller.h
Go to the documentation of this file.
1/***************************************************************************
2 qgscameracontroller.h
3 --------------------------------------
4 Date : July 2017
5 Copyright : (C) 2017 by Martin Dobias
6 Email : wonder dot sk at gmail dot com
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15
16#ifndef QGSCAMERACONTROLLER_H
17#define QGSCAMERACONTROLLER_H
18
19#include "qgis_3d.h"
20#include "qgscamerapose.h"
22
23#include <Qt3DCore/QEntity>
24#include <Qt3DInput/QMouseEvent>
25#include <QImage>
26
27#ifndef SIP_RUN
28namespace Qt3DInput
29{
30 class QKeyEvent;
31 class QKeyboardHandler;
32 class QMouseEvent;
33 class QMouseHandler;
34 class QWheelEvent;
35} // namespace Qt3DInput
36
37namespace Qt3DRender
38{
39 class QCamera;
40}
41
42#endif
43
44class QDomDocument;
45class QDomElement;
46
47class QgsCameraPose;
48class QgsVector3D;
50class Qgs3DMapScene;
51
56#ifndef SIP_RUN
57class _3D_EXPORT QgsCameraController : public Qt3DCore::QEntity
58{
59#else
60class _3D_EXPORT QgsCameraController : public QObject
61{
62#endif
63
64 Q_OBJECT
65 public:
69
70#ifndef SIP_RUN
71
76 Qt3DRender::QCamera *camera() const { return mCamera; }
77#endif
78
83 Qgis::NavigationMode cameraNavigationMode() const { return mCameraNavigationMode; }
84
89 double cameraMovementSpeed() const { return mCameraMovementSpeed; }
90
95 void setCameraMovementSpeed( double movementSpeed );
96
101 Qgis::VerticalAxisInversion verticalAxisInversion() const { return mVerticalAxisInversion; }
102
107 void setVerticalAxisInversion( Qgis::VerticalAxisInversion inversion );
108
110 void frameTriggered( float dt );
111
113 void resetView( float distance );
114
116 void setViewFromTop( float worldX, float worldY, float distance, float yaw = 0 );
117
119 QgsVector3D lookingAtPoint() const;
120
127 void setLookingAtPoint( const QgsVector3D &point, float distance, float pitch, float yaw );
128
133 QgsVector3D lookingAtMapPoint() const;
134
139 void setLookingAtMapPoint( const QgsVector3D &point, float distance, float pitch, float yaw );
140
145 void setCameraPose( const QgsCameraPose &camPose, bool force = false );
146
151 QgsCameraPose cameraPose() const { return mCameraPose; }
152
158 float distance() const { return mCameraPose.distanceFromCenterPoint(); }
159
165 float pitch() const { return mCameraPose.pitchAngle(); }
166
172 float yaw() const { return mCameraPose.headingAngle(); }
173
175 QDomElement writeXml( QDomDocument &doc ) const;
177 void readXml( const QDomElement &elem );
178
180 void zoom( float factor );
182 void tiltUpAroundViewCenter( float deltaPitch );
184 void rotateAroundViewCenter( float deltaYaw );
186 void setCameraHeadingAngle( float angle );
188 void moveView( float tx, float ty );
189
194 void walkView( double tx, double ty, double tz );
195
202 void rotateCamera( float diffPitch, float diffYaw );
203
209 void rotateCameraAroundPivot( float newPitch, float newHeading, const QVector3D &pivotPoint );
210
217 void zoomCameraAroundPivot( const QVector3D &oldCameraPosition, double zoomFactor, const QVector3D &pivotPoint );
218
223 bool keyboardEventFilter( QKeyEvent *event );
224
231 void setOrigin( const QgsVector3D &origin );
232
237 void setInputHandlersEnabled( bool enable ) { mInputHandlersEnabled = enable; }
238
243 bool hasInputHandlersEnabled() const { return mInputHandlersEnabled; }
244
251 void globeMoveCenterPoint( double latDiff, double lonDiff );
252
258 void globeZoom( float factor );
259
264 void globeUpdatePitchAngle( float angleDiff );
265
270 void globeUpdateHeadingAngle( float angleDiff );
271
277 void resetGlobe( float distance, double lat = 0, double lon = 0 );
278
283 const QgsVector3D origin() const { return mOrigin; }
284
285 // Convenience methods to set camera view to standard positions
287 void rotateCameraToHome() { rotateToRespectingTerrain( 45.0f, 45.0f ); }
289 void rotateCameraToTop() { rotateToRespectingTerrain( 0.0f, 90.0f ); }
291 void rotateCameraToNorth() { rotateToRespectingTerrain( 90.0f, 180.0f ); }
293 void rotateCameraToEast() { rotateToRespectingTerrain( 90.0f, 90.0f ); }
295 void rotateCameraToSouth() { rotateToRespectingTerrain( 90.0f, 0.0f ); }
297 void rotateCameraToWest() { rotateToRespectingTerrain( 90.0f, -90.0f ); }
299 void rotateCameraToBottom() { rotateToRespectingTerrain( 180.0f, 0.0f ); }
300
301 public slots:
302
307 void setCameraNavigationMode( Qgis::NavigationMode navigationMode );
308
313 void depthBufferCaptured( const QImage &depthImage );
314
315 private:
316#ifdef SIP_RUN
319#endif
320
321 void updateCameraFromPose();
322 void moveCameraPositionBy( const QVector3D &posDiff );
324 QWindow *window() const;
325
327 enum class MouseOperation
328 {
329 None = 0, // no operation
330 Translation, // left button pressed, no modifier
331 RotationCamera, // left button pressed + ctrl modifier
332 RotationCenter, // left button pressed + shift modifier
333 Zoom, // right button pressed
334 ZoomWheel // mouse wheel scroll
335 };
336
337 // This list gathers all the rotation and translation operations.
338 // It is used to update the appropriate parameters when successive
339 // translation and rotation happen.
340 const QList<MouseOperation> mTranslateOrRotate = {
341 MouseOperation::Translation,
342 MouseOperation::RotationCamera,
343 MouseOperation::RotationCenter
344 };
345
346 // check that current sequence (current operation and new operation) is a rotation or translation
347 bool isATranslationRotationSequence( MouseOperation newOperation ) const;
348
349 void setMouseParameters( const MouseOperation &newOperation, const QPoint &clickPoint = QPoint() );
350
356 void rotateToRespectingTerrain( float pitch, float yaw );
357
358 signals:
361
364
368 void cameraMovementSpeedChanged( double speed );
369
374 void setCursorPosition( QPoint point );
375
381
386 void cameraRotationCenterChanged( QVector3D position );
387
388 private slots:
389 void onPositionChanged( Qt3DInput::QMouseEvent *mouse );
390 void onWheel( Qt3DInput::QWheelEvent *wheel );
391 void onMousePressed( Qt3DInput::QMouseEvent *mouse );
392 void onMouseReleased( Qt3DInput::QMouseEvent *mouse );
393 void applyFlyModeKeyMovements();
394
395 private:
396 // All three methods return true if event is handled
397 bool onKeyPressedFlyNavigation( QKeyEvent *event );
398 bool onKeyPressedTerrainNavigation( QKeyEvent *event );
399 bool onKeyPressedGlobeTerrainNavigation( QKeyEvent *event );
400 void onPositionChangedFlyNavigation( Qt3DInput::QMouseEvent *mouse );
401 void onPositionChangedTerrainNavigation( Qt3DInput::QMouseEvent *mouse );
402 void onPositionChangedGlobeTerrainNavigation( Qt3DInput::QMouseEvent *mouse );
403
404 void handleTerrainNavigationWheelZoom();
405
412 double sampleDepthBuffer( int px, int py );
413
414 // Returns the average depth of all non void pixels
415 double depthBufferNonVoidAverage();
416
417#ifndef SIP_RUN
419 bool screenPointToWorldPos( QPoint position, double &depth, QVector3D &worldPosition );
420#endif
421
422 // Moves given point (in ECEF) by specified lat/lon angle difference (in degrees) and returns new ECEF point
423 QgsVector3D moveGeocentricPoint( const QgsVector3D &point, double latDiff, double lonDiff );
424
426 Qgs3DMapScene *mScene = nullptr;
427
429 Qt3DRender::QCamera *mCamera = nullptr;
430
432 QgsCameraPose mCameraPose;
433
435 QPoint mMousePos;
436
438 QPoint mClickPoint;
439
440 // false when no depth buffer captured or new capture requested and not yet done.
441 bool mDepthBufferIsReady = false;
442 QImage mDepthBufferImage;
443 // -1 when unset
444 // TODO: Change to std::optional<double>
445 double mDepthBufferNonVoidAverage = -1;
446 // nullptr when !mDepthBufferIsReady
447 std::unique_ptr<Qt3DRender::QCamera> mDepthBufferCamera;
448
449 std::unique_ptr<Qt3DRender::QCamera> mCameraBefore;
450
451 bool mRotationCenterCalculated = false;
452 QVector3D mRotationCenter;
453 double mRotationDistanceFromCenter = 0;
454 float mRotationPitch = 0;
455 float mRotationYaw = 0;
456
457 bool mDragPointCalculated = false;
458 QVector3D mDragPoint;
459 double mDragDepth;
460
461 bool mZoomPointCalculated = false;
462 QVector3D mZoomPoint;
463
464 // used for globe
465 QgsVector3D mMousePressViewCenter;
466 QgsCoordinateTransform mGlobeCrsToLatLon;
467
468 Qt3DInput::QMouseHandler *mMouseHandler = nullptr;
469 Qt3DInput::QKeyboardHandler *mKeyboardHandler = nullptr;
470 bool mInputHandlersEnabled = true;
473 double mCameraMovementSpeed = 5.0;
474
475 QSet<int> mDepressedKeys;
476 bool mCaptureFpsMouseMovements = false;
477 bool mIgnoreNextMouseMove = false;
478 QTimer *mFpsNavTimer = nullptr;
479
480 double mCumulatedWheelY = 0;
481
482 MouseOperation mCurrentOperation = MouseOperation::None;
483
484 // 3D world's origin in map coordinates
485 QgsVector3D mOrigin;
486
488 bool mCameraChanged = false;
489
490 // To test the cameracontroller
491 friend class TestQgs3DRendering;
492 friend class TestQgs3DCameraController;
493};
494
495#endif // QGSCAMERACONTROLLER_H
VerticalAxisInversion
Vertical axis inversion options for 3D views.
Definition qgis.h:4062
@ WhenDragging
Invert vertical axis movements when dragging in first person modes.
NavigationMode
The navigation mode used by 3D cameras.
Definition qgis.h:4037
@ TerrainBased
The default navigation based on the terrain.
Entity that encapsulates our 3D scene - contains all other entities (such as terrain) as children.
Object that controls camera movement based on user input.
void navigationModeChanged(Qgis::NavigationMode mode)
Emitted when the navigation mode is changed using the hotkey ctrl + ~.
bool hasInputHandlersEnabled() const
Returns whether the camera controller responds to mouse and keyboard events.
QgsCameraPose cameraPose() const
Returns camera pose.
void rotateCameraToBottom()
Rotate to bottom-up view.
float pitch() const
Returns pitch angle in degrees (0 = looking from the top, 90 = looking from the side).
Qt3DRender::QCamera * camera() const
Returns camera that is being controlled.
~QgsCameraController() override
float yaw() const
Returns yaw angle in degrees.
void requestDepthBufferCapture()
Emitted to ask for the depth buffer image.
Qgis::VerticalAxisInversion verticalAxisInversion() const
Returns the vertical axis inversion behavior.
void rotateCameraToTop()
Rotate to top-down view.
void rotateCameraToEast()
Rotate to view from the east.
const QgsVector3D origin() const
Returns the origin of the scene in map coordinates.
void rotateCameraToHome()
Rotate to diagonal view.
void rotateCameraToNorth()
Rotate to view from the north.
float distance() const
Returns distance of the camera from the point it is looking at.
void rotateCameraToWest()
Rotate to view from the west.
double cameraMovementSpeed() const
Returns the camera movement speed.
void cameraChanged()
Emitted when camera has been updated.
void cameraMovementSpeedChanged(double speed)
Emitted whenever the camera movement speed is changed by the controller.
void rotateCameraToSouth()
Rotate to view from the south.
Qgis::NavigationMode cameraNavigationMode() const
Returns the navigation mode used by the camera controller.
void cameraRotationCenterChanged(QVector3D position)
Emitted when the camera rotation center changes.
void setInputHandlersEnabled(bool enable)
Sets whether the camera controller responds to mouse and keyboard events.
void setCursorPosition(QPoint point)
Emitted when the mouse cursor position should be moved to the specified point on the map viewport.
Encapsulates camera pose in a 3D scene.
Handles coordinate transforms between two coordinate systems.
A 3D vector (similar to QVector3D) with the difference that it uses double precision instead of singl...
Definition qgsvector3d.h:30
On-screen 3D engine: it creates an OpenGL window (QWindow) and displays rendered 3D scenes there.
#define SIP_SKIP
Definition qgis_sip.h:126