fix(view): Adjust default camera height to compensate for screen aspect ratio

Author: Mauller

Core/GameEngine/Include/GameClient/View.h

@@ -172,7 +172,8 @@ class View : public Snapshot
 	virtual Bool isTimeFrozen(){ return false;}					///< Freezes time during the next camera movement.
 	virtual Int	 getTimeMultiplier() {return 1;};				///< Get the time multiplier.
 	virtual void setTimeMultiplier(Int multiple) {}; ///< Set the time multiplier.
-	virtual void setDefaultView(Real pitch, Real angle, Real maxHeight) {}; // TheSuperHackers @todo Replace with setDefaultPitch(), setMaxHeightScale()
+	virtual void setCameraHeightAboveGroundLimitsToDefault(Real heightScale = 1.0f) {};
+	virtual void setDefaultView(Real pitch, Real angle, Real maxHeight) {};
 	virtual void zoomCamera( Real finalZoom, Int milliseconds, Real easeIn=0.0f, Real easeOut=0.0f ) {};
 	virtual void pitchCamera( Real finalPitch, Int milliseconds, Real easeIn=0.0f, Real easeOut=0.0f ) {};
 
@@ -202,6 +203,7 @@ class View : public Snapshot
 	virtual Real getHeightAboveGround() { return m_heightAboveGround; }
 	virtual void setHeightAboveGround(Real z);
 	virtual void zoom( Real height ); ///< Zoom in/out, closer to the ground, limit to min, or farther away from the ground, limit to max
+	virtual void setZoomToMax();
 	virtual void setZoomToDefault() { m_zoom  = 1.0f; } ///< Set zoom to default value
 	virtual void setOkToAdjustHeight( Bool val ) { m_okToAdjustHeight = val; }	///< Set this to adjust camera height
 

Core/GameEngine/Source/GameClient/View.cpp

@@ -129,6 +129,11 @@ void View::zoom( Real height )
 	setHeightAboveGround(getHeightAboveGround() + height);
 }
 
+void View::setZoomToMax()
+{
+	setHeightAboveGround(getHeightAboveGround() + m_maxHeightAboveGround);
+}
+
 /**
  * Center the view on the given coordinate.
  */

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

@@ -208,12 +208,14 @@ class W3DView : public View, public SubsystemInterface
 	virtual Int	 getTimeMultiplier() override {return m_timeMultiplier;};///< Get the time multiplier.
 	virtual void setTimeMultiplier(Int multiple) override {m_timeMultiplier = multiple;}; ///< Set the time multiplier.
 	virtual void setDefaultView(Real pitch, Real angle, Real maxHeight) override;
+	virtual void setCameraHeightAboveGroundLimitsToDefault(Real heightScale = 1.0f) override;
 	virtual void zoomCamera( Real finalZoom, Int milliseconds, Real easeIn, Real easeOut ) override;
 	virtual void pitchCamera( Real finalPitch, Int milliseconds, Real easeIn, Real easeOut ) override;
 
 	virtual void setHeightAboveGround(Real z) override;
 	virtual void setZoom(Real z) override;
-	virtual void setZoomToDefault() override;									///< Set zoom to default value
+	virtual void setZoomToMax() override;
+	virtual void setZoomToDefault() override; ///< Set zoom to default value - TheSuperHackers @info This function resets the camera so will cause scripted cameras to halt
 
 	virtual void setFieldOfView( Real angle ) override;							///< Set the horizontal field of view angle
 

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

@@ -2179,6 +2179,31 @@ void W3DView::setPitchToDefault()
 	m_recalcCamera = true;
 }
 
+//-------------------------------------------------------------------------------------------------
+//-------------------------------------------------------------------------------------------------
+void W3DView::setCameraHeightAboveGroundLimitsToDefault(Real heightScale)
+{
+	// TheSuperHackers @fix Mauller Adjust the camera height to compensate for the screen aspect ratio
+	Real baseAspectRatio = (Real)DEFAULT_DISPLAY_WIDTH / (Real)DEFAULT_DISPLAY_HEIGHT;
+	Real currentAspectRatio = (Real)TheTacticalView->getWidth() / (Real)TheTacticalView->getHeight();
+	Real aspectRatioScale = 0.0f;
+
+	if (currentAspectRatio > baseAspectRatio)
+	{
+		aspectRatioScale = fabs(( 1 + ( currentAspectRatio - baseAspectRatio) ));
+	}
+	else
+	{
+		aspectRatioScale = fabs(( 1 - ( baseAspectRatio - currentAspectRatio) ));
+	}
+
+	m_maxHeightAboveGround = TheGlobalData->m_maxCameraHeight * aspectRatioScale * heightScale;
+	m_minHeightAboveGround = TheGlobalData->m_minCameraHeight * aspectRatioScale;
+
+	if (m_minHeightAboveGround > m_maxHeightAboveGround)
+		m_maxHeightAboveGround = m_minHeightAboveGround;
+}
+
 //-------------------------------------------------------------------------------------------------
 //-------------------------------------------------------------------------------------------------
 void W3DView::setDefaultView(Real pitch, Real angle, Real maxHeight)
@@ -2222,12 +2247,29 @@ void W3DView::setZoom(Real z)
 
 //-------------------------------------------------------------------------------------------------
 //-------------------------------------------------------------------------------------------------
-void W3DView::setZoomToDefault()
+void W3DView::setZoomToMax()
 {
-	// default zoom has to be max, otherwise players will just zoom to max always
+	// terrain height + desired height offset == cameraOffset * actual zoom
+	// find best approximation of max terrain height we can see
+	Real terrainHeightMax = getHeightAroundPos(m_pos.x, m_pos.y);
+
+	Real desiredHeight = (terrainHeightMax + m_maxHeightAboveGround);
+	Real desiredZoom = desiredHeight / getCameraOffsetZ();
+
+	//DEBUG_LOG(("W3DView::setZoomToDefault() Current zoom: %g  Desired zoom: %g", m_zoom, desiredZoom));
+
+	m_zoom = desiredZoom;
 	m_heightAboveGround = m_maxHeightAboveGround;
-	m_zoom = getMaxZoom(m_pos.x, m_pos.y);
 
+	m_cameraAreaConstraintsValid = false; // recalc it.
+	m_recalcCamera = true;
+}
+
+//-------------------------------------------------------------------------------------------------
+//-------------------------------------------------------------------------------------------------
+void W3DView::setZoomToDefault()
+{
+	// default zoom has to be max, otherwise players will just zoom to max always
 	stopDoingScriptedCamera();
 	m_CameraArrivedAtWaypointOnPathFlag = false;
 	m_cameraAreaConstraintsValid = false;

GeneralsMD/Code/GameEngine/Include/Common/GlobalData.h

@@ -188,8 +188,11 @@ class GlobalData : public SubsystemInterface
 #if PRESERVE_RETAIL_SCRIPTED_CAMERA
 	Real m_cameraHeight;
 #endif
+
+	 // TheSuperHackers @info Max and Min camera height for the original 4:3 view, these are then scaled for other aspect ratios.
 	Real m_maxCameraHeight;
 	Real m_minCameraHeight;
+
 	Real m_terrainHeightAtEdgeOfMap;
 	Real m_unitDamagedThresh;
 	Real m_unitReallyDamagedThresh;

GeneralsMD/Code/GameEngine/Include/GameLogic/ScriptActions.h

@@ -111,7 +111,7 @@ class ScriptActions : public ScriptActionsInterface
 
 	void doCameraTetherNamed(const AsciiString& unit, Bool snapToUnit, Real play);
 	void doCameraStopTetherNamed();
-	void doCameraSetDefault(Real pitch, Real angle, Real maxHeight);
+	void doCameraSetDefault(Real pitch, Real angle, Real heighScale);
 
 	void doOversizeTheTerrain(Int amount);
 	void doMoveCameraAlongWaypointPath(const AsciiString& waypoint, Real sec, Real cameraStutterSec, Real easeIn, Real easeOut);

GeneralsMD/Code/GameEngine/Source/GameClient/GUI/GUICallbacks/Menus/OptionsMenu.cpp

@@ -880,6 +880,11 @@ static void saveOptions()
 
 				TheInGameUI->recreateControlBar();
 				TheInGameUI->refreshCustomUiResources();
+
+				// TheSuperHackers @info Only update the camera limits and set the zoom to max to not interfere with the scripted camera on the shellmap
+				// The tactical view gets reset at game start, this is here so the shell map looks correct once the resolution is adjusted
+				TheTacticalView->setCameraHeightAboveGroundLimitsToDefault();
+				TheTacticalView->setZoomToMax();
 			}
 		}
 	}

GeneralsMD/Code/GameEngine/Source/GameClient/InGameUI.cpp

@@ -1376,10 +1376,7 @@ void InGameUI::init()
 		// make the tactical display the full screen width and height
 		TheTacticalView->setWidth( TheDisplay->getWidth() );
 		TheTacticalView->setHeight( TheDisplay->getHeight() );
-		TheTacticalView->setDefaultView(
-			DEG_TO_RADF(TheGlobalData->m_cameraPitch),
-			DEG_TO_RADF(TheGlobalData->m_cameraYaw),
-			1.0f);
+		TheTacticalView->setCameraHeightAboveGroundLimitsToDefault();
 	}
 
 	/** @todo this may be the wrong place to create the sidebar, but for now
@@ -2150,10 +2147,7 @@ void InGameUI::reset()
 	// reset the command bar
 	TheControlBar->reset();
 
-	TheTacticalView->setDefaultView(
-		DEG_TO_RADF(TheGlobalData->m_cameraPitch),
-		DEG_TO_RADF(TheGlobalData->m_cameraYaw),
-		1.0f);
+	TheTacticalView->setCameraHeightAboveGroundLimitsToDefault();
 
 	ResetInGameChat();
 

GeneralsMD/Code/GameEngine/Source/GameLogic/ScriptEngine/ScriptActions.cpp

@@ -4603,15 +4603,17 @@ void ScriptActions::doCameraStopTetherNamed()
 //-------------------------------------------------------------------------------------------------
 /** doCameraSetDefault */
 //-------------------------------------------------------------------------------------------------
-void ScriptActions::doCameraSetDefault(Real pitch, Real angle, Real maxHeight)
+void ScriptActions::doCameraSetDefault(Real pitch, Real angle, Real heighScale)
 {
 #if PRESERVE_RETAIL_SCRIPTED_CAMERA
 	// TheSuperHackers @tweak To preserve the original scripted camera values, offset them by default ones.
 	pitch = -pitch + ViewDefaultPitchRadians;
 	angle = angle + ViewDefaultYawRadians;
 #endif
 
-	TheTacticalView->setDefaultView(pitch, angle, maxHeight);
+	TheTacticalView->setCameraHeightAboveGroundLimitsToDefault(heighScale);
+	TheTacticalView->setPitch(pitch);
+	TheTacticalView->setAngle(angle);
 }
 
 //-------------------------------------------------------------------------------------------------

GeneralsMD/Code/GameEngine/Source/GameLogic/System/GameLogic.cpp

@@ -2085,9 +2085,12 @@ void GameLogic::tryStartNewGame( Bool loadingSaveGame )
 	// update the loadscreen
 	updateLoadProgress(LOAD_PROGRESS_POST_PRELOAD_ASSETS);
 
+	// TheSuperHackers @info Initialize the camera height limits to default if the resolution was changed
+	TheTacticalView->setCameraHeightAboveGroundLimitsToDefault();
 	TheTacticalView->setAngleToDefault();
 	TheTacticalView->setPitchToDefault();
 	TheTacticalView->setZoomToDefault();
+	TheTacticalView->setZoomToMax();
 
 	if( TheRecorder )
 		TheRecorder->initControls();