Add global 3d setting to control whether vertical mouse axis movement…

…s should be inverted
qgis · Jan 14, 2021 · 7fa38ce · 7fa38ce
1 parent 553c747
commit 7fa38ce
Show file tree

Hide file tree

Showing 5 changed files with 92 additions and 21 deletions.
diff --git a/src/3d/qgscameracontroller.cpp b/src/3d/qgscameracontroller.cpp
@@ -76,6 +76,11 @@ void QgsCameraController::setCameraMovementSpeed( double movementSpeed )
   mCameraMovementSpeed = movementSpeed;
 }
 
+void QgsCameraController::setVerticalAxisInversion( QgsCameraController::VerticalAxisInversion inversion )
+{
+  mVerticalAxisInversion = inversion;
+}
+
 void QgsCameraController::setTerrainEntity( QgsTerrainEntity *te )
 {
   mTerrainEntity = te;
@@ -626,7 +631,18 @@ void QgsCameraController::onPositionChangedFlyNavigation( Qt3DInput::QMouseEvent
 
     if ( mPressedButton != Qt3DInput::QMouseEvent::RightButton )
     {
-      float diffPitch = -1 * 0.2f * dy;
+      float diffPitch = -0.2f * dy;
+      switch ( mVerticalAxisInversion )
+      {
+        case Always:
+          diffPitch *= -1;
+          break;
+
+        case WhenDragging:
+        case Never:
+          break;
+      }
+
       float diffYaw = - 0.2f * dx;
       rotateCamera( diffPitch, diffYaw );
       updateCameraFromPose( false );
@@ -651,7 +667,17 @@ void QgsCameraController::onPositionChangedFlyNavigation( Qt3DInput::QMouseEvent
 
     if ( mPressedButton ==  Qt3DInput::QMouseEvent::LeftButton || mPressedButton ==  Qt3DInput::QMouseEvent::MiddleButton )
     {
-      float diffPitch = 0.2f * dy;
+      float diffPitch = -0.2f * dy;
+      switch ( mVerticalAxisInversion )
+      {
+        case Always:
+        case WhenDragging:
+          diffPitch *= -1;
+          break;
+
+        case Never:
+          break;
+      }
       float diffYaw = - 0.2f * dx;
       rotateCamera( diffPitch, diffYaw );
       updateCameraFromPose( false );

diff --git a/src/3d/qgscameracontroller.h b/src/3d/qgscameracontroller.h
@@ -67,11 +67,20 @@ class _3D_EXPORT QgsCameraController : public Qt3DCore::QEntity
     //! The navigation mode used by the camera
     enum NavigationMode
     {
-      TerrainBasedNavigation, //! The default navigation based on the terrain
-      WalkNavigation //! Uses WASD keys or arrows to navigate in walking (first person) manner
+      TerrainBasedNavigation, //!< The default navigation based on the terrain
+      WalkNavigation //!< Uses WASD keys or arrows to navigate in walking (first person) manner
     };
     Q_ENUM( NavigationMode )
 
+    //! Vertical axis inversion options
+    enum VerticalAxisInversion
+    {
+      Never, //!< Never invert vertical axis movements
+      WhenDragging, //!< Invert vertical axis movements when dragging in first person modes
+      Always, //!< Always invert vertical axis movements
+    };
+    Q_ENUM( VerticalAxisInversion )
+
   public:
     //! Constructs the camera controller with optional parent node that will take ownership
     QgsCameraController( Qt3DCore::QNode *parent = nullptr );
@@ -82,13 +91,13 @@ class _3D_EXPORT QgsCameraController : public Qt3DCore::QEntity
     QRect viewport() const { return mViewport; }
 
     /**
-     * Returns the nvigtion mode used by the camera controller
+     * Returns the navigation mode used by the camera controller.
      * \since QGIS 3.18
      */
     QgsCameraController::NavigationMode cameraNavigationMode() const { return mCameraNavigationMode; }
 
     /**
-     * Sets the nvigtion mode used by the camera controller
+     * Sets the navigation mode used by the camera controller.
      * \since QGIS 3.18
      */
     void setCameraNavigationMode( QgsCameraController::NavigationMode navigationMode );
@@ -105,6 +114,18 @@ class _3D_EXPORT QgsCameraController : public Qt3DCore::QEntity
      */
     void setCameraMovementSpeed( double movementSpeed );
 
+    /**
+     * Returns the vertical axis inversion behavior.
+     * \since QGIS 3.18
+     */
+    QgsCameraController::VerticalAxisInversion verticalAxisInversion() const { return mVerticalAxisInversion; }
+
+    /**
+     * Sets the vertical axis \a inversion behavior.
+     * \since QGIS 3.18
+     */
+    void setVerticalAxisInversion( QgsCameraController::VerticalAxisInversion inversion );
+
     /**
      * Connects to object picker attached to terrain entity. Called internally from 3D scene.
      * This allows camera controller understand how far from the camera is the terrain under mouse cursor.
@@ -243,6 +264,7 @@ class _3D_EXPORT QgsCameraController : public Qt3DCore::QEntity
     Qt3DInput::QMouseHandler *mMouseHandler = nullptr;
     Qt3DInput::QKeyboardHandler *mKeyboardHandler = nullptr;
     NavigationMode mCameraNavigationMode = NavigationMode::TerrainBasedNavigation;
+    VerticalAxisInversion mVerticalAxisInversion = WhenDragging;
     double mCameraMovementSpeed = 5.0;
 
     QSet< int > mDepressedKeys;

diff --git a/src/app/3d/qgs3doptions.cpp b/src/app/3d/qgs3doptions.cpp
@@ -38,13 +38,20 @@ Qgs3DOptionsWidget::Qgs3DOptionsWidget( QWidget *parent )
   cboCameraProjectionType->addItem( tr( "Perspective Projection" ), Qt3DRender::QCameraLens::PerspectiveProjection );
   cboCameraProjectionType->addItem( tr( "Orthogonal Projection" ), Qt3DRender::QCameraLens::OrthographicProjection );
 
+  mInvertVerticalAxisCombo->addItem( tr( "Never" ), QgsCameraController::Never );
+  mInvertVerticalAxisCombo->addItem( tr( "Only When Dragging" ), QgsCameraController::WhenDragging );
+  mInvertVerticalAxisCombo->addItem( tr( "Always" ), QgsCameraController::Always );
+
   mCameraMovementSpeed->setClearValue( 4 );
   spinCameraFieldOfView->setClearValue( 45.0 );
 
   QgsSettings settings;
   const QgsCameraController::NavigationMode defaultNavMode = settings.enumValue( QStringLiteral( "map3d/defaultNavigation" ), QgsCameraController::TerrainBasedNavigation, QgsSettings::App );
   mCameraNavigationModeCombo->setCurrentIndex( mCameraNavigationModeCombo->findData( static_cast< int >( defaultNavMode ) ) );
 
+  const QgsCameraController::VerticalAxisInversion axisInversion = settings.enumValue( QStringLiteral( "map3d/axisInversion" ), QgsCameraController::WhenDragging, QgsSettings::App );
+  mInvertVerticalAxisCombo->setCurrentIndex( mInvertVerticalAxisCombo->findData( static_cast< int >( axisInversion ) ) );
+
   const Qt3DRender::QCameraLens::ProjectionType defaultProjection = settings.enumValue( QStringLiteral( "map3d/defaultProjection" ), Qt3DRender::QCameraLens::PerspectiveProjection, QgsSettings::App );
   cboCameraProjectionType->setCurrentIndex( cboCameraProjectionType->findData( static_cast< int >( defaultProjection ) ) );
 
@@ -56,6 +63,7 @@ void Qgs3DOptionsWidget::apply()
 {
   QgsSettings settings;
   settings.setValue( QStringLiteral( "map3d/defaultNavigation" ), static_cast< QgsCameraController::NavigationMode >( mCameraNavigationModeCombo->currentData().toInt() ), QgsSettings::App );
+  settings.setValue( QStringLiteral( "map3d/axisInversion" ), static_cast< QgsCameraController::VerticalAxisInversion >( mInvertVerticalAxisCombo->currentData().toInt() ), QgsSettings::App );
   settings.setValue( QStringLiteral( "map3d/defaultProjection" ), static_cast< Qt3DRender::QCameraLens::ProjectionType >( cboCameraProjectionType->currentData().toInt() ), QgsSettings::App );
   settings.setValue( QStringLiteral( "map3d/defaultMovementSpeed" ), mCameraMovementSpeed->value(), QgsSettings::App );
   settings.setValue( QStringLiteral( "map3d/defaultFieldOfView" ), spinCameraFieldOfView->value(), QgsSettings::App );

diff --git a/src/app/qgisapp.cpp b/src/app/qgisapp.cpp
@@ -13315,6 +13315,7 @@ void QgisApp::new3DMapCanvas()
 
     const QgsCameraController::NavigationMode defaultNavMode = settings.enumValue( QStringLiteral( "map3d/defaultNavigation" ), QgsCameraController::TerrainBasedNavigation, QgsSettings::App );
     map->setCameraNavigationMode( defaultNavMode );
+
     map->setCameraMovementSpeed( settings.value( QStringLiteral( "map3d/defaultMovementSpeed" ), 5, QgsSettings::App ).toDouble() );
     const Qt3DRender::QCameraLens::ProjectionType defaultProjection = settings.enumValue( QStringLiteral( "map3d/defaultProjection" ), Qt3DRender::QCameraLens::PerspectiveProjection, QgsSettings::App );
     map->setProjectionType( defaultProjection );
@@ -13342,6 +13343,10 @@ void QgisApp::new3DMapCanvas()
     QgsRectangle extent = mMapCanvas->extent();
     float dist = static_cast< float >( std::max( extent.width(), extent.height() ) );
     dock->mapCanvas3D()->setViewFromTop( mMapCanvas->extent().center(), dist, static_cast< float >( mMapCanvas->rotation() ) );
+
+    const QgsCameraController::VerticalAxisInversion axisInversion = settings.enumValue( QStringLiteral( "map3d/axisInversion" ), QgsCameraController::WhenDragging, QgsSettings::App );
+    if ( dock->mapCanvas3D()->cameraController() )
+      dock->mapCanvas3D()->cameraController()->setVerticalAxisInversion( axisInversion );
   }
 #endif
 }

diff --git a/src/ui/3d/qgs3doptionsbase.ui b/src/ui/3d/qgs3doptionsbase.ui
@@ -69,12 +69,8 @@
            <string>Default Camera Settings</string>
           </property>
           <layout class="QGridLayout" name="gridLayout">
-           <item row="1" column="0">
-            <widget class="QLabel" name="labelCameraProjectionType">
-             <property name="text">
-              <string>Projection type</string>
-             </property>
-            </widget>
+           <item row="1" column="1" colspan="2">
+            <widget class="QComboBox" name="cboCameraProjectionType"/>
            </item>
            <item row="2" column="1" colspan="2">
             <widget class="QgsSpinBox" name="spinCameraFieldOfView">
@@ -86,20 +82,17 @@
              </property>
             </widget>
            </item>
-           <item row="2" column="0">
-            <widget class="QLabel" name="labelFieldofView">
+           <item row="1" column="0">
+            <widget class="QLabel" name="labelCameraProjectionType">
              <property name="text">
-              <string>Field of View</string>
+              <string>Projection type</string>
              </property>
             </widget>
            </item>
-           <item row="1" column="1" colspan="2">
-            <widget class="QComboBox" name="cboCameraProjectionType"/>
-           </item>
-           <item row="3" column="0">
-            <widget class="QLabel" name="labelCameraNavigationMode">
+           <item row="2" column="0">
+            <widget class="QLabel" name="labelFieldofView">
              <property name="text">
-              <string>Navigation mode</string>
+              <string>Field of View</string>
              </property>
             </widget>
            </item>
@@ -119,13 +112,30 @@
              </property>
             </widget>
            </item>
+           <item row="3" column="0">
+            <widget class="QLabel" name="labelCameraNavigationMode">
+             <property name="text">
+              <string>Navigation mode</string>
+             </property>
+            </widget>
+           </item>
            <item row="4" column="0">
             <widget class="QLabel" name="labelMovementSpeed">
              <property name="text">
               <string>Movement speed</string>
              </property>
             </widget>
            </item>
+           <item row="5" column="0">
+            <widget class="QLabel" name="labelCameraNavigationMode_2">
+             <property name="text">
+              <string>Invert vertical axis</string>
+             </property>
+            </widget>
+           </item>
+           <item row="5" column="1" colspan="2">
+            <widget class="QComboBox" name="mInvertVerticalAxisCombo"/>
+           </item>
           </layout>
          </widget>
         </item>