Improve readability of vsync and settings update code

src/overlaycontroller.cpp

@@ -390,7 +390,7 @@ void OverlayController::SetWidget( QQuickItem* quickItem,
              this,
              SLOT( OnTimeoutPumpEvents() ) );
 
-    // was     m_pPumpEventsTimer->setInterval( 20 );
+    // Every 1ms we check if the current frame has advanced (for vysnc)
     m_pPumpEventsTimer->setInterval( 1 );
 
     m_pPumpEventsTimer->start();
@@ -523,11 +523,27 @@ void OverlayController::processInputBindings()
         m_actions.optionalOverrideRightHandPlayspaceRotate() );
 }
 
+// vsync implementation:
+// (this function triggers every 1ms)
 void OverlayController::OnTimeoutPumpEvents()
 {
+    // get the current frame number from the VRSystem frame counter
     vr::VRSystem()->GetTimeSinceLastVsync( nullptr, &m_currentFrame );
 
+    // Check if we are in the next frame yet
     if ( m_currentFrame > m_lastFrame )
+    {
+        // If the frame has advanced since last check, it's time for our main
+        // event loop. (this function should trigger about every 11ms assuming
+        // 90fps compositor)
+        mainEventLoop();
+
+        // wait for the next frame after executing our main event loop once.
+        m_lastFrame = m_currentFrame;
+    }
+}
+
+void OverlayController::mainEventLoop()
 {
     if ( !vr::VRSystem() )
         return;
@@ -544,12 +560,10 @@ void OverlayController::OnTimeoutPumpEvents()
         {
         case vr::VREvent_MouseMove:
         {
-                QPoint ptNewMouse
+            QPoint ptNewMouse = getMousePositionForEvent( vrEvent.data.mouse );
-                    = getMousePositionForEvent( vrEvent.data.mouse );
             if ( ptNewMouse != m_ptLastMouse )
             {
-                    QMouseEvent mouseEvent(
+                QMouseEvent mouseEvent( QEvent::MouseMove,
-                        QEvent::MouseMove,
                                         ptNewMouse,
                                         m_pWindow->mapToGlobal( ptNewMouse ),
                                         Qt::NoButton,
@@ -564,8 +578,7 @@ void OverlayController::OnTimeoutPumpEvents()
 
         case vr::VREvent_MouseButtonDown:
         {
-                QPoint ptNewMouse
+            QPoint ptNewMouse = getMousePositionForEvent( vrEvent.data.mouse );
-                    = getMousePositionForEvent( vrEvent.data.mouse );
             Qt::MouseButton button
                 = vrEvent.data.mouse.button == vr::VRMouseButton_Right
                       ? Qt::RightButton
@@ -583,8 +596,7 @@ void OverlayController::OnTimeoutPumpEvents()
 
         case vr::VREvent_MouseButtonUp:
         {
-                QPoint ptNewMouse
+            QPoint ptNewMouse = getMousePositionForEvent( vrEvent.data.mouse );
-                    = getMousePositionForEvent( vrEvent.data.mouse );
             Qt::MouseButton button
                 = vrEvent.data.mouse.button == vr::VRMouseButton_Right
                       ? Qt::RightButton
@@ -702,8 +714,8 @@ void OverlayController::OnTimeoutPumpEvents()
                 == vr::TrackingResult_Running_OK )
     {
         auto& vel = devicePoses[leftId].vVelocity.v;
-            leftSpeed = std::sqrt( vel[0] * vel[0] + vel[1] * vel[1]
+        leftSpeed
-                                   + vel[2] * vel[2] );
+            = std::sqrt( vel[0] * vel[0] + vel[1] * vel[1] + vel[2] * vel[2] );
     }
     auto rightId = vr::VRSystem()->GetTrackedDeviceIndexForControllerRole(
         vr::TrackedControllerRole_RightHand );
@@ -714,8 +726,8 @@ void OverlayController::OnTimeoutPumpEvents()
                 == vr::TrackingResult_Running_OK )
     {
         auto& vel = devicePoses[rightId].vVelocity.v;
-            rightSpeed = std::sqrt( vel[0] * vel[0] + vel[1] * vel[1]
+        rightSpeed
-                                    + vel[2] * vel[2] );
+            = std::sqrt( vel[0] * vel[0] + vel[1] * vel[1] + vel[2] * vel[2] );
     }
     auto hmdSpeed = 0.0f;
     if ( devicePoses[vr::k_unTrackedDeviceIndex_Hmd].bPoseIsValid
@@ -723,8 +735,8 @@ void OverlayController::OnTimeoutPumpEvents()
                 == vr::TrackingResult_Running_OK )
     {
         auto& vel = devicePoses[vr::k_unTrackedDeviceIndex_Hmd].vVelocity.v;
-            hmdSpeed = std::sqrt( vel[0] * vel[0] + vel[1] * vel[1]
+        hmdSpeed
-                                  + vel[2] * vel[2] );
+            = std::sqrt( vel[0] * vel[0] + vel[1] * vel[1] + vel[2] * vel[2] );
     }
     m_moveCenterTabController.eventLoopTick(
         vr::VRCompositor()->GetTrackingSpace(), devicePoses );
@@ -756,8 +768,6 @@ void OverlayController::OnTimeoutPumpEvents()
             }
         }
     }
-        m_lastFrame = m_currentFrame;
-    }
 }
 
 void OverlayController::AddOffsetToUniverseCenter(

src/overlaycontroller.h

@@ -167,6 +167,7 @@ public:
 
     bool pollNextEvent( vr::VROverlayHandle_t ulOverlayHandle,
                         vr::VREvent_t* pEvent );
+    void mainEventLoop();
 
 public slots:
     void renderOverlay();

src/tabcontrollers/AccessibilityTabController.cpp

@@ -116,6 +116,19 @@ void AccessibilityTabController::eventLoopTick(
     {
         return;
     }
+
+    // 151 was chosen because it's a prime number (to reduce overlap of
+    // simultaneous settings updates).
+    // Actual rate of updates is 151 * vsync (~11ms)
+    // Values chosen based on update speed priority
+    // Values in other tabs are as follows (avoid using same values):
+    // AudioTabController: 89
+    // ChaperoneTabController: 101
+    // MoveCenterTabController: 149
+    // ReviveTabController: 139
+    // SettingsTabController: 157
+    // SteamVRTabController: 97
+    // UtilitiesTabController: 19
     if ( settingsUpdateCounter >= 151 )
     {
         if ( parent->isDashboardVisible() )

src/tabcontrollers/AudioTabController.cpp

@@ -168,6 +168,19 @@ void AudioTabController::eventLoopTick()
     {
         return;
     }
+
+    // 89 was chosen because it's a prime number (to reduce overlap of
+    // simultaneous settings updates).
+    // Actual rate of updates is 89 * vsync (~11ms)
+    // Values chosen based on update speed priority
+    // Values in other tabs are as follows (avoid using same values):
+    // AccessibiltyTabController: 151
+    // ChaperoneTabController: 101
+    // MoveCenterTabController: 149
+    // ReviveTabController: 139
+    // SettingsTabController: 157
+    // SteamVRTabController: 97
+    // UtilitiesTabController: 19
     if ( settingsUpdateCounter >= 89 )
     {
         if ( m_micProximitySensorCanMute )

src/tabcontrollers/ChaperoneTabController.cpp

@@ -649,6 +649,18 @@ void ChaperoneTabController::eventLoopTick(
         }
     }
 
+    // 101 was chosen because it's a prime number (to reduce overlap of
+    // simultaneous settings updates).
+    // Actual rate of updates is 101 * vsync (~11ms)
+    // Values chosen based on update speed priority
+    // Values in other tabs are as follows (avoid using same values):
+    // AccessibiltyTabController: 151
+    // AudioTabController: 89
+    // MoveCenterTabController: 149
+    // ReviveTabController: 139
+    // SettingsTabController: 157
+    // SteamVRTabController: 97
+    // UtilitiesTabController: 19
     if ( settingsUpdateCounter >= 101 )
     {
         if ( parent->isDashboardVisible() )

src/tabcontrollers/MoveCenterTabController.cpp

@@ -976,6 +976,18 @@ void MoveCenterTabController::eventLoopTick(
     vr::ETrackingUniverseOrigin universe,
     vr::TrackedDevicePose_t* devicePoses )
 {
+    // 149 was chosen because it's a prime number (to reduce overlap of
+    // simultaneous settings updates).
+    // Actual rate of updates is 149 * vsync (~11ms)
+    // Values chosen based on update speed priority
+    // Values in other tabs are as follows (avoid using same values):
+    // AccessibiltyTabController: 151
+    // AudioTabController: 89
+    // ChaperoneTabController: 101
+    // ReviveTabController: 139
+    // SettingsTabController: 157
+    // SteamVRTabController: 97
+    // UtilitiesTabController: 19
     if ( settingsUpdateCounter >= 149 )
     {
         if ( parent->isDashboardVisible() )

src/tabcontrollers/ReviveTabController.cpp

@@ -309,6 +309,18 @@ void ReviveTabController::eventLoopTick()
     if ( m_isOverlayInstalled
          || parent->m_settingsTabController.forceRevivePage() )
     {
+        // 139 was chosen because it's a prime number (to reduce overlap of
+        // simultaneous settings updates).
+        // Actual rate of updates is 139 * vsync (~11ms)
+        // Values chosen based on update speed priority
+        // Values in other tabs are as follows (avoid using same values):
+        // AccessibiltyTabController: 151
+        // AudioTabController: 89
+        // ChaperoneTabController: 101
+        // MoveCenterTabController: 149
+        // SettingsTabController: 157
+        // SteamVRTabController: 97
+        // UtilitiesTabController: 19
         if ( settingsUpdateCounter >= 139 )
         {
             if ( parent->isDashboardVisible() )

src/tabcontrollers/SettingsTabController.cpp

@@ -28,6 +28,18 @@ void SettingsTabController::initStage2( OverlayController* var_parent,
 
 void SettingsTabController::eventLoopTick()
 {
+    // 157 was chosen because it's a prime number (to reduce overlap of
+    // simultaneous settings updates).
+    // Actual rate of updates is 157 * vsync (~11ms)
+    // Values chosen based on update speed priority
+    // Values in other tabs are as follows (avoid using same values):
+    // AccessibiltyTabController: 151
+    // AudioTabController: 89
+    // ChaperoneTabController: 101
+    // MoveCenterTabController: 149
+    // ReviveTabController: 139
+    // SteamVRTabController: 97
+    // UtilitiesTabController: 19
     if ( settingsUpdateCounter >= 157 )
     {
         if ( parent->isDashboardVisible() )

src/tabcontrollers/SteamVRTabController.cpp

@@ -22,6 +22,18 @@ void SteamVRTabController::initStage2( OverlayController* var_parent,
 
 void SteamVRTabController::eventLoopTick()
 {
+    // 97 was chosen because it's a prime number (to reduce overlap of
+    // simultaneous settings updates).
+    // Actual rate of updates is 97 * vsync (~11ms)
+    // Values chosen based on update speed priority
+    // Values in other tabs are as follows (avoid using same values):
+    // AccessibiltyTabController: 151
+    // AudioTabController: 89
+    // ChaperoneTabController: 101
+    // MoveCenterTabController: 149
+    // ReviveTabController: 139
+    // SettingsTabController: 157
+    // UtilitiesTabController: 19
     if ( settingsUpdateCounter >= 97 )
     {
         if ( parent->isDashboardVisible() )

src/tabcontrollers/UtilitiesTabController.cpp

@@ -321,6 +321,18 @@ vr::VROverlayHandle_t createBatteryOverlay( vr::TrackedDeviceIndex_t index )
 
 void UtilitiesTabController::eventLoopTick()
 {
+    // 19 was chosen because it's a prime number (to reduce overlap of
+    // simultaneous settings updates).
+    // Actual rate of updates is 19 * vsync (~11ms)
+    // Values chosen based on update speed priority
+    // Values in other tabs are as follows (avoid using same values):
+    // AccessibiltyTabController: 151
+    // AudioTabController: 89
+    // ChaperoneTabController: 101
+    // MoveCenterTabController: 149
+    // ReviveTabController: 139
+    // SettingsTabController: 157
+    // SteamVRTabController: 97
     if ( settingsUpdateCounter >= 19 )
     {
         vr::VROverlayHandle_t pOverlayHandle;