fix(view): Adjust default camera height based on aspect ratio

Author: Mauller

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

@@ -189,7 +189,7 @@ class GlobalData : public SubsystemInterface
 	Real m_cameraPitch;
 	Real m_cameraYaw;
 	Real m_cameraHeight;
-	Real m_maxCameraHeight;
+	Real m_maxCameraHeight;	// TheSuperHackers @info Max camera height for the original 4:3 view, this is then scaled for other aspect ratios.
 	Real m_minCameraHeight;
 	Real m_terrainHeightAtEdgeOfMap;
 	Real m_unitDamagedThresh;

GeneralsMD/Code/GameEngine/Include/GameClient/View.h

@@ -171,7 +171,7 @@ class View : public Snapshot
 	virtual Bool isTimeFrozen(void){ return false;}					///< Freezes time during the next camera movement.
 	virtual Int	 getTimeMultiplier(void) {return 1;};				///< Get the time multiplier.
 	virtual void setTimeMultiplier(Int multiple) {}; ///< Set the time multiplier.
-	virtual void setDefaultView(Real pitch, Real angle, Real maxHeight) {};
+	virtual void setDefaultCameraHeight(Real heightScale = 1.0f) {};
 	virtual void zoomCamera( Real finalZoom, Int milliseconds, Real easeIn, Real easeOut ) {};
 	virtual void pitchCamera( Real finalPitch, Int milliseconds, Real easeIn, Real easeOut ) {};
 
@@ -189,7 +189,8 @@ 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 setZoomToDefault( void ) { m_zoom  = 1.0f; } ///< Set zoom to default value
+	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
 
 	// for debugging

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

@@ -114,7 +114,7 @@ class ScriptActions : public ScriptActionsInterface
 
 	void doCameraTetherNamed(const AsciiString& unit, Bool snapToUnit, Real play);
 	void doCameraStopTetherNamed(void);
-	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

@@ -1560,6 +1560,11 @@ static void saveOptions( void )
 
 				TheInGameUI->recreateControlBar();
 				TheInGameUI->refreshCustomUiResources();
+
+				// TheSuperHackers @info Only update the default view and soft reset the zoom otherwise it throws off the scripted camera in the shellmap
+				// The view gets reset at game start, this is here so the shell map looks correct once the resolution is adjusted
+				TheTacticalView->setDefaultCameraHeight();
+				TheTacticalView->setZoomToMax();
 			}
 		}
 	}

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

@@ -1249,7 +1249,7 @@ void InGameUI::init( void )
 		TheTacticalView->setWidth( TheDisplay->getWidth() );
 		TheTacticalView->setHeight( TheDisplay->getHeight() );
 	}
-	TheTacticalView->setDefaultView(0.0f, 0.0f, 1.0f);
+	TheTacticalView->setDefaultCameraHeight();
 
 	/** @todo this may be the wrong place to create the sidebar, but for now
 	this is where it lives */
@@ -2000,7 +2000,7 @@ void InGameUI::reset( void )
 	// reset the command bar
 	TheControlBar->reset();
 
-	TheTacticalView->setDefaultView(0.0f, 0.0f, 1.0f);
+	TheTacticalView->setDefaultCameraHeight();
 
 	ResetInGameChat();
 

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

@@ -129,6 +129,11 @@ void View::zoom( Real height )
 	setHeightAboveGround(getHeightAboveGround() + height);
 }
 
+void View::setZoomToMax()
+{
+	setHeightAboveGround(getHeightAboveGround() + m_maxHeightAboveGround);
+}
+
 void View::lockViewUntilFrame(UnsignedInt frame)
 {
 	m_viewLockedUntilFrame = frame;

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

@@ -4609,9 +4609,11 @@ void ScriptActions::doCameraStopTetherNamed(void)
 //-------------------------------------------------------------------------------------------------
 /** doCameraSetDefault */
 //-------------------------------------------------------------------------------------------------
-void ScriptActions::doCameraSetDefault(Real pitch, Real angle, Real maxHeight)
+void ScriptActions::doCameraSetDefault(Real pitch, Real angle, Real heighScale)
 {
-	TheTacticalView->setDefaultView(pitch, angle, maxHeight);
+	TheTacticalView->setDefaultCameraHeight(heighScale);
+	TheTacticalView->setPitch(pitch);
+	TheTacticalView->setAngle(angle);
 }
 
 //-------------------------------------------------------------------------------------------------

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

@@ -2063,6 +2063,8 @@ void GameLogic::startNewGame( Bool loadingSaveGame )
 	// update the loadscreen
 	updateLoadProgress(LOAD_PROGRESS_POST_PRELOAD_ASSETS);
 
+	// TheSuperHackers @info Initialize the default view to update the max height if the resolution was changed
+	TheTacticalView->setDefaultCameraHeight();
 	TheTacticalView->setAngleAndPitchToDefault();
 	TheTacticalView->setZoomToDefault();
 

GeneralsMD/Code/GameEngineDevice/Include/W3DDevice/GameClient/W3DView.h

@@ -193,13 +193,14 @@ class W3DView : public View, public SubsystemInterface
 	virtual	void Add_Camera_Shake(const Coord3D & position,float radius, float duration, float power); //WST 10.18.2002
 	virtual Int	 getTimeMultiplier(void) {return m_timeMultiplier;};///< Get the time multiplier.
 	virtual void setTimeMultiplier(Int multiple) {m_timeMultiplier = multiple;}; ///< Set the time multiplier.
-	virtual void setDefaultView(Real pitch, Real angle, Real maxHeight);
+	virtual void setDefaultCameraHeight(Real heightScale = 1.0f);
 	virtual void zoomCamera( Real finalZoom, Int milliseconds, Real easeIn, Real easeOut );
 	virtual void pitchCamera( Real finalPitch, Int milliseconds, Real easeIn, Real easeOut );
 
 	virtual void setHeightAboveGround(Real z);
 	virtual void setZoom(Real z);
-	virtual void setZoomToDefault( void );									///< Set zoom to default value
+	virtual void setZoomToMax();
+	virtual void setZoomToDefault();									///< Set zoom to default value
 
 	virtual void setFieldOfView( Real angle );							///< Set the horizontal field of view angle
 

GeneralsMD/Code/GameEngineDevice/Source/W3DDevice/GameClient/W3DView.cpp

@@ -1922,12 +1922,25 @@ void W3DView::setAngleAndPitchToDefault( void )
 
 //-------------------------------------------------------------------------------------------------
 //-------------------------------------------------------------------------------------------------
-void W3DView::setDefaultView(Real pitch, Real angle, Real maxHeight)
+void W3DView::setDefaultCameraHeight(Real heightScale)
 {
-	// MDC - we no longer want to rotate maps (design made all of them right to begin with)
-	//	m_defaultAngle = angle * M_PI/180.0f;
-	m_defaultPitchAngle = pitch;
-	m_maxHeightAboveGround = TheGlobalData->m_maxCameraHeight*maxHeight;
+	// TheSuperHackers @fix Mauller Adjust the max 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;
 }
@@ -1970,10 +1983,8 @@ void W3DView::setZoom(Real z)
 
 //-------------------------------------------------------------------------------------------------
 //-------------------------------------------------------------------------------------------------
-void W3DView::setZoomToDefault( void )
+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);
@@ -1986,14 +1997,24 @@ void W3DView::setZoomToDefault( void )
 	m_zoom = desiredZoom;
 	m_heightAboveGround = m_maxHeightAboveGround;
 
+	m_cameraConstraintValid = false; // recalc it.
+	setCameraTransform();
+}
+
+//-------------------------------------------------------------------------------------------------
+//-------------------------------------------------------------------------------------------------
+void W3DView::setZoomToDefault()
+{
+	// default zoom has to be max, otherwise players will just zoom to max always
+
+	// TheSuperHackers @info This function resets the camera so will cause scripted cameras to halt
 	m_doingMoveCameraOnWaypointPath = false;
 	m_CameraArrivedAtWaypointOnPathFlag = false;
 	m_doingRotateCamera = false;
 	m_doingPitchCamera = false;
 	m_doingZoomCamera = false;
 	m_doingScriptedCameraLock = false;
-	m_cameraConstraintValid = false; // recalc it.
-	setCameraTransform();
+	setZoomToMax();
 }
 
 //-------------------------------------------------------------------------------------------------