fix(view): Improve setup of default camera pitch and angle (#2546)

This adds two new meta events: DEMO_BEGIN_ADJUST_DEFAULTPITCH, DEMO_END_ADJUST_DEFAULTPITCH, which are default mapped to CTRL + MK_COMMA

Author: xezon

Core/GameEngine/Include/GameClient/View.h

@@ -34,6 +34,7 @@
 #include "Common/Snapshot.h"
 #include "Lib/BaseType.h"
 #include "WW3D2/coltype.h"			///< we don't generally do this, but we need the W3D collision types
+#include "WWMath/wwmath.h"
 
 #define DEFAULT_VIEW_WIDTH 640
 #define DEFAULT_VIEW_HEIGHT 480
@@ -50,7 +51,9 @@ enum FilterTypes CPP_11(: Int);
 enum FilterModes CPP_11(: Int);
 
 // ------------------------------------------------------------------------------------------------
-// ------------------------------------------------------------------------------------------------
+constexpr const Real ViewDefaultPitchRadians = DEG_TO_RADF(37.5f);
+constexpr const Real ViewDefaultYawRadians = DEG_TO_RADF(0.0f);
+
 // ------------------------------------------------------------------------------------------------
 enum PickType CPP_11(: Int)
 {
@@ -177,8 +180,11 @@ class View : public Snapshot
 
 	virtual void setAngle( Real radians );															///< Rotate the view around the vertical axis to the given angle (yaw)
 	virtual Real getAngle() { return m_angle; }										///< Return current camera angle
+	virtual Real getDefaultAngle() { return m_defaultAngle; }			///< Return current default camera angle
 	virtual void setPitch( Real radians );															///< Rotate the view around the horizontal axis to the given angle (pitch)
 	virtual Real getPitch() { return m_pitch; }										///< Return current camera pitch
+	virtual void setDefaultPitch( Real radians );												///< Set new default camera pitch. It affects the camera distance to the ground
+	virtual Real getDefaultPitch() { return m_defaultPitch; }						///< Return current default camera pitch
 	virtual void setAngleToDefault();															///< Set the view angle back to default
 	virtual void setPitchToDefault();															///< Set the view pitch back to default
 	void setPosition( const Coord3D *pos ) { m_pos = *pos; }
@@ -199,6 +205,7 @@ class View : public Snapshot
 	Bool userSetAngle(Real radians)                      { return doUserAction(&View::setAngle, radians); }
 	Bool userSetAngleToDefault()                         { return doUserAction(&View::setAngleToDefault); }
 	Bool userSetPitch(Real radians)                      { return doUserAction(&View::setPitch, radians); }
+	Bool userSetDefaultPitch(Real radians)               { return doUserAction(&View::setDefaultPitch, radians); }
 	Bool userSetPitchToDefault()                         { return doUserAction(&View::setPitchToDefault); }
 	Bool userZoom(Real height)                           { return doUserAction(&View::zoom, height); }
 	Bool userSetZoom(Real z)                             { return doUserAction(&View::setZoom, z); }

Core/GameEngine/Source/GameClient/View.cpp

@@ -102,8 +102,10 @@ void View::init()
 	m_minHeightAboveGround = TheGlobalData->m_minCameraHeight;
 	m_okToAdjustHeight = FALSE;
 
-	m_defaultAngle = 0.0f;
-	m_defaultPitch = 0.0f;
+	m_defaultAngle = DEG_TO_RADF(TheGlobalData->m_cameraYaw);
+	m_defaultPitch = DEG_TO_RADF(TheGlobalData->m_cameraPitch);
+	m_angle = m_defaultAngle;
+	m_pitch = m_defaultPitch;
 }
 
 void View::reset()
@@ -160,13 +162,26 @@ void View::setAngle( Real radians )
 	m_angle = WWMath::Normalize_Angle(radians);
 }
 
+#define CLAMP_VIEW_PITCH 1
 /**
  * Rotate the view around the horizontal (X) axis to the given angle.
  */
 void View::setPitch( Real radians )
 {
-	constexpr Real limit = PI/5.0f;
-	m_pitch = clamp(-limit, radians, limit);
+#if CLAMP_VIEW_PITCH
+	m_pitch = clamp(DEG_TO_RADF(0.1f), radians, DEG_TO_RADF(89.9f));
+#else
+	m_pitch = WWMath::Normalize_Angle(radians);
+#endif
+}
+
+void View::setDefaultPitch( Real radians )
+{
+#if CLAMP_VIEW_PITCH
+	m_defaultPitch = clamp(DEG_TO_RADF(0.1f), radians, DEG_TO_RADF(89.9f));
+#else
+	m_defaultPitch = WWMath::Normalize_Angle(radians);
+#endif
 }
 
 /**

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

@@ -171,6 +171,7 @@ class W3DView : public View, public SubsystemInterface
 
 	virtual void setAngle( Real radians ) override;									///< Rotate the view around the vertical axis to the given angle (yaw)
 	virtual void setPitch( Real radians ) override;									///< Rotate the view around the horizontal axis to the given angle (pitch)
+	virtual void setDefaultPitch( Real radians ) override;						///< Set new default camera pitch. It affects the camera distance to the ground
 	virtual void setAngleToDefault() override;									///< Set the view angle back to default
 	virtual void setPitchToDefault() override;									///< Set the view pitch back to default
 

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

@@ -264,8 +264,8 @@ void W3DView::buildCameraPosition( Vector3& sourcePos, Vector3& targetPos )
 	// TheSuperHackers @info The default pitch affects the look-at distance to the target.
 	// This is strange math which would need special attention when changed.
 	sourcePos.Z = getCameraOffsetZ();
-	sourcePos.Y = -(sourcePos.Z / tan(TheGlobalData->m_cameraPitch * (PI / 180.0)));
-	sourcePos.X = -(sourcePos.Y * tan(TheGlobalData->m_cameraYaw * (PI / 180.0)));
+	sourcePos.Y = -(sourcePos.Z / tan(ViewDefaultPitchRadians));
+	sourcePos.X = -(sourcePos.Y * tan(ViewDefaultYawRadians));
 
 	// set position of camera itself
 	if (m_useRealZoomCam) //WST 10/10/2002 Real Zoom using FOV
@@ -285,13 +285,15 @@ void W3DView::buildCameraPosition( Vector3& sourcePos, Vector3& targetPos )
 	targetPos.Y = 0;
 	targetPos.Z = 0;
 
+	// TheSuperHackers @info Scales the source position later by this much
+	// to achieve the intended camera height. Must not scale before pitching!
 	const Real heightScale = 1.0f - (groundLevel / sourcePos.Z);
 
 	// construct a matrix to rotate around the up vector by the given angle
-	const Matrix3D angleTransform( Vector3( 0.0f, 0.0f, 1.0f ), angle );
+	const Matrix3D angleTransform( Vector3( 0.0f, 0.0f, 1.0f ), angle - ViewDefaultYawRadians );
 
 	// construct a matrix to rotate around the left vector by the given angle
-	const Matrix3D pitchTransform( Vector3( -1.0f, 0.0f, 0.0f ), pitch );
+	const Matrix3D pitchTransform( Vector3( -1.0f, 0.0f, 0.0f ), pitch - ViewDefaultPitchRadians );
 
 	// rotate camera position (pitch, then angle)
 #ifdef ALLOW_TEMPORARIES
@@ -2067,6 +2069,16 @@ void W3DView::setPitch( Real radians )
 	m_recalcCamera = true;
 }
 
+//-------------------------------------------------------------------------------------------------
+//-------------------------------------------------------------------------------------------------
+void W3DView::setDefaultPitch( Real radians )
+{
+	View::setDefaultPitch( radians );
+
+	m_cameraAreaConstraintsValid = false;
+	m_recalcCamera = true;
+}
+
 //-------------------------------------------------------------------------------------------------
 /** Set the view angle back to default */
 //-------------------------------------------------------------------------------------------------
@@ -2098,7 +2110,7 @@ void W3DView::setDefaultView(Real pitch, Real angle, Real maxHeight)
 {
 	// 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_defaultPitch = pitch;
+	setDefaultPitch(pitch);
 	m_maxHeightAboveGround = TheGlobalData->m_maxCameraHeight*maxHeight;
 	if (m_minHeightAboveGround > m_maxHeightAboveGround)
 		m_maxHeightAboveGround = m_minHeightAboveGround;

Generals/Code/GameEngine/Include/Common/MessageStream.h

@@ -218,7 +218,7 @@ class GameMessage : public MemoryPoolObject
 		MSG_META_SELECT_PREV_UNIT,									///< select 'prev' unit
 		MSG_META_SELECT_NEXT_WORKER,                ///< select 'next' worker
 		MSG_META_SELECT_PREV_WORKER,                ///< select 'prev' worker
-		MSG_META_SELECT_NEXT_IDLE_WORKER,                        ///< TheSuperHackers @feature L3-M 03/08/2025 select next idle worker
+		MSG_META_SELECT_NEXT_IDLE_WORKER,           ///< TheSuperHackers @feature L3-M 03/08/2025 select next idle worker
 		MSG_META_VIEW_COMMAND_CENTER,								///< center view on command center
 		MSG_META_VIEW_LAST_RADAR_EVENT,							///< center view on last radar event
 		MSG_META_SELECT_HERO,                       ///< selects player's hero character, if exists...
@@ -319,6 +319,8 @@ class GameMessage : public MemoryPoolObject
 		MSG_META_DEMO_PLAY_OBJECTIVE_MOVIE6,				///< play specific "Objective" movie
 		MSG_META_DEMO_BEGIN_ADJUST_PITCH,						///< enter adjust-pitch mode
 		MSG_META_DEMO_END_ADJUST_PITCH,							///< exit adjust-pitch mode
+		MSG_META_DEMO_BEGIN_ADJUST_DEFAULTPITCH,		///< TheSuperHackers @feature Enter adjust-default-pitch mode
+		MSG_META_DEMO_END_ADJUST_DEFAULTPITCH,			///< TheSuperHackers @feature Exit adjust-default-pitch mode
 		MSG_META_DEMO_BEGIN_ADJUST_FOV,							///< enter adjust-FOV mode
 		MSG_META_DEMO_END_ADJUST_FOV,								///< exit adjust-FOV mode
 		MSG_META_DEMO_LOCK_CAMERA_TO_PLANES,				///< lock camera to airborne thingies

Generals/Code/GameEngine/Include/GameClient/LookAtXlat.h

@@ -74,7 +74,8 @@ class LookAtTranslator : public GameMessageTranslator
 	Real m_anchorAngle;
 	Bool m_isScrolling;				// set to true if we are in the act of RMB scrolling
 	Bool m_isRotating;					// set to true if we are in the act of MMB rotating
-	Bool m_isPitching;					// set to true if we are in the act of ALT pitch rotation
+	Bool m_isPitching;					// set to true if we are in the act of pitch rotation
+	Bool m_isPitchingToDefault; // set to true if we are in the act of default pitch rotation
 	Bool m_isChangingFOV;			// set to true if we are in the act of changing the field of view
 	UnsignedInt m_middleButtonDownTimeMsec;				// real-time in milliseconds when middle button goes down
 	DrawableID m_lastPlaneID;

Generals/Code/GameEngine/Source/Common/MessageStream.cpp

@@ -326,6 +326,7 @@ const char *GameMessage::getCommandTypeAsString(GameMessage::Type t)
 	CASE_LABEL(MSG_META_SELECT_PREV_UNIT)
 	CASE_LABEL(MSG_META_SELECT_NEXT_WORKER)
 	CASE_LABEL(MSG_META_SELECT_PREV_WORKER)
+	CASE_LABEL(MSG_META_SELECT_NEXT_IDLE_WORKER)
 	CASE_LABEL(MSG_META_VIEW_COMMAND_CENTER)
 	CASE_LABEL(MSG_META_VIEW_LAST_RADAR_EVENT)
 	CASE_LABEL(MSG_META_SELECT_HERO)
@@ -368,8 +369,10 @@ const char *GameMessage::getCommandTypeAsString(GameMessage::Type t)
 	CASE_LABEL(MSG_META_TOGGLE_ATTACKMOVE)
 	CASE_LABEL(MSG_META_BEGIN_CAMERA_ROTATE_LEFT)
 	CASE_LABEL(MSG_META_END_CAMERA_ROTATE_LEFT)
+	CASE_LABEL(MSG_META_ALT_CAMERA_ROTATE_LEFT)
 	CASE_LABEL(MSG_META_BEGIN_CAMERA_ROTATE_RIGHT)
 	CASE_LABEL(MSG_META_END_CAMERA_ROTATE_RIGHT)
+	CASE_LABEL(MSG_META_ALT_CAMERA_ROTATE_RIGHT)
 	CASE_LABEL(MSG_META_BEGIN_CAMERA_ZOOM_IN)
 	CASE_LABEL(MSG_META_END_CAMERA_ZOOM_IN)
 	CASE_LABEL(MSG_META_BEGIN_CAMERA_ZOOM_OUT)
@@ -419,6 +422,8 @@ const char *GameMessage::getCommandTypeAsString(GameMessage::Type t)
 	CASE_LABEL(MSG_META_DEMO_PLAY_OBJECTIVE_MOVIE6)
 	CASE_LABEL(MSG_META_DEMO_BEGIN_ADJUST_PITCH)
 	CASE_LABEL(MSG_META_DEMO_END_ADJUST_PITCH)
+	CASE_LABEL(MSG_META_DEMO_BEGIN_ADJUST_DEFAULTPITCH)
+	CASE_LABEL(MSG_META_DEMO_END_ADJUST_DEFAULTPITCH)
 	CASE_LABEL(MSG_META_DEMO_BEGIN_ADJUST_FOV)
 	CASE_LABEL(MSG_META_DEMO_END_ADJUST_FOV)
 	CASE_LABEL(MSG_META_DEMO_LOCK_CAMERA_TO_PLANES)

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

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

Generals/Code/GameEngine/Source/GameClient/MessageStream/LookAtXlat.cpp

@@ -136,6 +136,7 @@ LookAtTranslator::LookAtTranslator() :
 	m_isScrolling(false),
 	m_isRotating(false),
 	m_isPitching(false),
+	m_isPitchingToDefault(false),
 	m_isChangingFOV(false),
 	m_middleButtonDownTimeMsec(0),
 	m_lastPlaneID(INVALID_DRAWABLE_ID),
@@ -389,6 +390,15 @@ GameMessageDisposition LookAtTranslator::translateGameMessage(const GameMessage
 			}
 
 #if defined(RTS_DEBUG)
+			if (m_isPitchingToDefault)
+			{
+				constexpr const Real Scale = 0.01f;
+				const Real angle = Scale * (m_currentPos.y - m_anchor.y);
+				TheTacticalView->userSetDefaultPitch( TheTacticalView->getDefaultPitch() - angle );
+				TheTacticalView->userSetPitchToDefault();
+				m_anchor = msg->getArgument( 0 )->pixel;
+			}
+
 			// adjust the field of view
 			if (m_isChangingFOV)
 			{
@@ -565,6 +575,29 @@ GameMessageDisposition LookAtTranslator::translateGameMessage(const GameMessage
 		}
 #endif // #if defined(RTS_DEBUG)
 
+		// ------------------------------------------------------------------------
+#if defined(RTS_DEBUG)
+		case GameMessage::MSG_META_DEMO_BEGIN_ADJUST_DEFAULTPITCH:
+		{
+			DEBUG_ASSERTCRASH(!m_isPitchingToDefault, ("hmm, mismatched m_isPitchingToDefault"));
+			m_isPitchingToDefault = true;
+			m_anchor = m_currentPos;
+			disp = DESTROY_MESSAGE;
+			break;
+		}
+#endif // #if defined(RTS_DEBUG)
+
+		// ------------------------------------------------------------------------
+#if defined(RTS_DEBUG)
+		case GameMessage::MSG_META_DEMO_END_ADJUST_DEFAULTPITCH:
+		{
+			DEBUG_ASSERTCRASH(m_isPitchingToDefault, ("hmm, mismatched m_isPitchingToDefault"));
+			m_isPitchingToDefault = false;
+			disp = DESTROY_MESSAGE;
+			break;
+		}
+#endif // #if defined(RTS_DEBUG)
+
 		// ------------------------------------------------------------------------
 #if defined(RTS_DEBUG)
 		case GameMessage::MSG_META_DEMO_DESHROUD:
@@ -722,5 +755,6 @@ void LookAtTranslator::resetModes()
 	m_isScrolling = FALSE;
 	m_isRotating = FALSE;
 	m_isPitching = FALSE;
+	m_isPitchingToDefault = FALSE;
 	m_isChangingFOV = FALSE;
 }

Generals/Code/GameEngine/Source/GameClient/MessageStream/MetaEvent.cpp

@@ -229,6 +229,8 @@ static const LookupListRec GameMessageMetaTypeNames[] =
 	{ "DEMO_PLAY_OBJECTIVE_MOVIE6",								GameMessage::MSG_META_DEMO_PLAY_OBJECTIVE_MOVIE6 },
 	{ "DEMO_BEGIN_ADJUST_PITCH",									GameMessage::MSG_META_DEMO_BEGIN_ADJUST_PITCH },
 	{ "DEMO_END_ADJUST_PITCH",										GameMessage::MSG_META_DEMO_END_ADJUST_PITCH },
+	{ "DEMO_BEGIN_ADJUST_DEFAULTPITCH",						GameMessage::MSG_META_DEMO_BEGIN_ADJUST_DEFAULTPITCH },
+	{ "DEMO_END_ADJUST_DEFAULTPITCH",							GameMessage::MSG_META_DEMO_END_ADJUST_DEFAULTPITCH },
 	{ "DEMO_BEGIN_ADJUST_FOV",										GameMessage::MSG_META_DEMO_BEGIN_ADJUST_FOV },
 	{ "DEMO_END_ADJUST_FOV",											GameMessage::MSG_META_DEMO_END_ADJUST_FOV },
 	{ "DEMO_LOCK_CAMERA_TO_PLANES",								GameMessage::MSG_META_DEMO_LOCK_CAMERA_TO_PLANES },
@@ -837,6 +839,28 @@ MetaMapRec *MetaMap::getMetaMapRec(GameMessage::Type t)
 			map->m_usableIn = COMMANDUSABLE_GAME;
 		}
 	}
+	{
+		// Is useful for Generals and Zero Hour.
+		MetaMapRec *map = TheMetaMap->getMetaMapRec(GameMessage::MSG_META_DEMO_BEGIN_ADJUST_DEFAULTPITCH);
+		if (map->m_key == MK_NONE)
+		{
+			map->m_key = MK_COMMA;
+			map->m_transition = DOWN;
+			map->m_modState = CTRL;
+			map->m_usableIn = COMMANDUSABLE_GAME;
+		}
+	}
+	{
+		// Is useful for Generals and Zero Hour.
+		MetaMapRec *map = TheMetaMap->getMetaMapRec(GameMessage::MSG_META_DEMO_END_ADJUST_DEFAULTPITCH);
+		if (map->m_key == MK_NONE)
+		{
+			map->m_key = MK_COMMA;
+			map->m_transition = UP;
+			map->m_modState = CTRL;
+			map->m_usableIn = COMMANDUSABLE_GAME;
+		}
+	}
 #endif // defined(RTS_DEBUG)
 }