perf(view): Optimize and simplify camera transform update logic

Author: xezon

Core/GameEngineDevice/Include/W3DDevice/GameClient/W3DView.h

@@ -277,6 +277,7 @@ class W3DView : public View, public SubsystemInterface
 
 	Region2D m_cameraAreaConstraints; ///< Camera should be constrained to be within this area
 	Bool m_cameraAreaConstraintsValid; ///< If false, recalculates the camera area constraints in the next render update
+	Bool m_recalcCamera; ///< Recalculates the camera transform in the next render update
 
 	void setCameraTransform(void); ///< set the transform matrix of m_3DCamera, based on m_pos & m_angle
 	void buildCameraTransform(Matrix3D *transform); ///< calculate (but do not set) the transform matrix of m_3DCamera, based on m_pos & m_angle

Core/GameEngineDevice/Source/W3DDevice/GameClient/W3DView.cpp

@@ -166,6 +166,8 @@ W3DView::W3DView()
 	m_shakerAngles.Y =0.0f;
 	m_shakerAngles.Z =0.0f;
 
+	m_recalcCamera = true;
+
 }
 
 //-------------------------------------------------------------------------------------------------
@@ -606,9 +608,6 @@ void W3DView::init( void )
 	// create our 3D camera
 	m_3DCamera = NEW_REF( CameraClass, () );
 
-
-	setCameraTransform();
-
 	// create our 2D camera for the GUI overlay
 	m_2DCamera = NEW_REF( CameraClass, () );
 	m_2DCamera->Set_Position( Vector3( 0, 0, 1 ) );
@@ -621,6 +620,7 @@ void W3DView::init( void )
 
 	m_scrollAmountCutoff = TheGlobalData->m_scrollAmountCutoff;
 
+	m_recalcCamera = true;
 }
 
 //-------------------------------------------------------------------------------------------------
@@ -1072,7 +1072,6 @@ void W3DView::stepView()
 void W3DView::update(void)
 {
 	//USE_PERF_TIMER(W3DView_updateView)
-	Bool recalcCamera = false;
 	Bool didScriptedMovement = false;
 #ifdef LOG_FRAME_TIMES
 	__int64 curTime64,freq64;
@@ -1174,8 +1173,6 @@ void W3DView::update(void)
 						Matrix3D camXForm;
 						camXForm.Look_At(camtran,objPos,0);
 						m_3DCamera->Set_Transform(camXForm);
-
-						recalcCamera = false;	//we already did it
 					}
 				}
 			}
@@ -1256,7 +1253,7 @@ void W3DView::update(void)
 
 				m_groundLevel = objpos.z;
 				didScriptedMovement = true;
-				recalcCamera = true;
+				m_recalcCamera = true;
 			}
 		}
 	}
@@ -1265,7 +1262,7 @@ void W3DView::update(void)
 		// If we aren't frozen for debug, allow the camera to follow scripted movements.
 		if (updateCameraMovements()) {
 			didScriptedMovement = true;
-			recalcCamera = true;
+			m_recalcCamera = true;
 		}
 	} else {
 		if (m_doingRotateCamera || m_doingMoveCameraOnWaypointPath || m_doingPitchCamera || m_doingZoomCamera || m_doingScriptedCameraLock) {
@@ -1277,13 +1274,13 @@ void W3DView::update(void)
 	//
 	if (m_shakeIntensity > 0.01f)
 	{
-		recalcCamera = true;
+		m_recalcCamera = true;
 	}
 
 	//Process New C3 Camera Shaker system
 	if (CameraShakerSystem.IsCameraShaking())
 	{
-		recalcCamera = true;
+		m_recalcCamera = true;
 	}
 
 	/*
@@ -1330,7 +1327,7 @@ void W3DView::update(void)
 			if (fabs(zoomAdj) >= 0.0001f)
 			{
 				m_zoom += zoomAdj;
-				recalcCamera = true;
+				m_recalcCamera = true;
 			}
 		}
 	}
@@ -1340,8 +1337,10 @@ void W3DView::update(void)
 	}
 
 	// (gth) C&C3 if m_isCameraSlaved then force the camera to update each frame
-	if (recalcCamera || m_isCameraSlaved) {
+	if (m_recalcCamera || m_isCameraSlaved)
+	{
 		setCameraTransform();
+		m_recalcCamera = false;
 	}
 
 #ifdef DO_SEISMIC_SIMULATIONS
@@ -1797,9 +1796,7 @@ void W3DView::scrollBy( Coord2D *delta )
 		//m_cameraConstraintValid = false;	// pos change does NOT invalidate cam constraints
 
 		m_doingRotateCamera = false;
-		// set new camera position
-		setCameraTransform();
-
+		m_recalcCamera = true;
 	}
 
 }
@@ -1808,8 +1805,7 @@ void W3DView::scrollBy( Coord2D *delta )
 //-------------------------------------------------------------------------------------------------
 void W3DView::forceRedraw()
 {
-	// set the camera
-	setCameraTransform();
+	m_recalcCamera = true;
 }
 
 //-------------------------------------------------------------------------------------------------
@@ -1826,8 +1822,7 @@ void W3DView::setAngle( Real radians )
 	m_doingPitchCamera = false;
 	m_doingZoomCamera = false;
 	m_doingScriptedCameraLock = false;
-	// set the camera
-	setCameraTransform();
+	m_recalcCamera = true;
 }
 
 //-------------------------------------------------------------------------------------------------
@@ -1842,8 +1837,7 @@ void W3DView::setPitch( Real radians )
 	m_doingPitchCamera = false;
 	m_doingZoomCamera = false;
 	m_doingScriptedCameraLock = false;
-	// set the camera
-	setCameraTransform();
+	m_recalcCamera = true;
 }
 
 //-------------------------------------------------------------------------------------------------
@@ -1853,7 +1847,7 @@ void W3DView::setAngleToDefault( void )
 {
 	View::setAngleToDefault();
 
-	setCameraTransform();
+	m_recalcCamera = true;
 }
 
 //-------------------------------------------------------------------------------------------------
@@ -1865,7 +1859,7 @@ void W3DView::setPitchToDefault( void )
 
 	m_FXPitch = 1.0f;
 
-	setCameraTransform();
+	m_recalcCamera = true;
 }
 
 //-------------------------------------------------------------------------------------------------
@@ -1893,7 +1887,7 @@ void W3DView::setHeightAboveGround(Real z)
 	m_doingZoomCamera = false;
 	m_doingScriptedCameraLock = false;
 	m_cameraAreaConstraintsValid = false;
-	setCameraTransform();
+	m_recalcCamera = true;
 }
 
 //-------------------------------------------------------------------------------------------------
@@ -1913,7 +1907,7 @@ void W3DView::setZoom(Real z)
 	m_doingZoomCamera = false;
 	m_doingScriptedCameraLock = false;
 	m_cameraAreaConstraintsValid = false;
-	setCameraTransform();
+	m_recalcCamera = true;
 }
 
 //-------------------------------------------------------------------------------------------------
@@ -1941,7 +1935,7 @@ void W3DView::setZoomToDefault( void )
 	m_doingZoomCamera = false;
 	m_doingScriptedCameraLock = false;
 	m_cameraAreaConstraintsValid = false;
-	setCameraTransform();
+	m_recalcCamera = true;
 }
 
 //-------------------------------------------------------------------------------------------------
@@ -1954,7 +1948,7 @@ void W3DView::setFieldOfView( Real angle )
 #if defined(RTS_DEBUG)
 	// this is only for testing, and recalculating the
 	// camera every frame is wasteful
-	setCameraTransform();
+	m_recalcCamera = true;
 #endif
 }
 
@@ -2297,8 +2291,7 @@ void W3DView::lookAt( const Coord3D *o )
 	m_CameraArrivedAtWaypointOnPathFlag = false;
 	m_doingScriptedCameraLock = false;
 
-	setCameraTransform();
-
+	m_recalcCamera = true;
 }
 
 //-------------------------------------------------------------------------------------------------
@@ -2315,8 +2308,7 @@ void W3DView::initHeightForMap( void )
 	m_cameraOffset.y = -(m_cameraOffset.z / tan(TheGlobalData->m_cameraPitch * (PI / 180.0)));
 	m_cameraOffset.x = -(m_cameraOffset.y * tan(TheGlobalData->m_cameraYaw * (PI / 180.0)));
 	m_cameraAreaConstraintsValid = false;	// possible ground level change invalidates camera constraints
-	setCameraTransform();
-
+	m_recalcCamera = true;
 }
 
 //-------------------------------------------------------------------------------------------------
@@ -3275,7 +3267,7 @@ void W3DView::cameraDisableRealZoomMode(void) //WST added 10/18/2002
 	m_FXPitch = 1.0f;	//Reset to default
 	//m_zoom = 1.0f;
 	m_FOV = DEG_TO_RADF(50.0f);
-	setCameraTransform();
+	m_recalcCamera = true;
 	updateView();
 }