tweak(water): Decouple water movement time step from render update

Author: xezon

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

@@ -168,7 +168,7 @@ class WaterRenderObjClass : public Snapshot,
 	Int m_numIndices;				///<number of indices in D3D index buffer
 	LPDIRECT3DTEXTURE8 m_pBumpTexture[NUM_BUMP_FRAMES]; ///<animation frames
 	LPDIRECT3DTEXTURE8 m_pBumpTexture2[NUM_BUMP_FRAMES]; ///<animation frames
-	Int					m_iBumpFrame;	///<current animation frame
+	Real				m_fBumpFrame;	///<current animation frame
 	Real				m_fBumpScale;	///<scales bump map uv perturbation
 	TextureClass * m_pReflectionTexture;	///<render target for reflection
 	RenderObjClass	*m_skyBox;		///<box around level

GeneralsMD/Code/GameEngineDevice/Source/W3DDevice/GameClient/Water/W3DWater.cpp

@@ -49,6 +49,7 @@
 #include "mesh.h"
 #include "matinfo.h"
 
+#include "Common/GameEngine.h"
 #include "Common/GameState.h"
 #include "Common/GlobalData.h"
 #include "Common/PerfTimer.h"
@@ -984,7 +985,7 @@ void WaterRenderObjClass::load(void)
 Int WaterRenderObjClass::init(Real waterLevel, Real dx, Real dy, SceneClass *parentScene, WaterType type)
 {
 
-	m_iBumpFrame=0;
+	m_fBumpFrame=0;
 	m_fBumpScale=SEA_BUMP_SCALE;
 
 	m_dx=dx;
@@ -1204,38 +1205,35 @@ void WaterRenderObjClass::enableWaterGrid(Bool state)
 }
 
 // ------------------------------------------------------------------------------------------------
-/** Update phase for water if we need it.  This called once per client frame reguardless
-	* of how fast the logic framerate is running */
+/** Update phase for water if we need it. */
 // ------------------------------------------------------------------------------------------------
 void WaterRenderObjClass::update( void )
 {
-	static UnsignedInt lastLogicFrame = 0;
-	UnsignedInt currLogicFrame = 0;
+	// TheSuperHackers @tweak The water movement time step is now decoupled from the render update.
+	const Real timeScale = TheGameEngine->getActualLogicTimeScaleOverFpsRatio();
 
-	if( TheGameLogic )
-		currLogicFrame = TheGameLogic->getFrame();
-
-	// we only process things if the logic frame has changed
-	if( lastLogicFrame != currLogicFrame )
 	{
+		constexpr const Real MagicOffset = 0.0125 * 33 / 5000; ///< the work of top Munkees; do not question it
 
-		m_riverVOrigin += 0.002f;
-		m_riverXOffset += (Real)(0.0125*33/5000);
-		m_riverYOffset += (Real)(2*0.0125*33/5000);
-		if (m_riverXOffset > 1) m_riverXOffset -= 1;
-		if (m_riverYOffset > 1) m_riverYOffset -= 1;
-		if (m_riverXOffset < -1) m_riverXOffset += 1;
-		if (m_riverYOffset < -1) m_riverYOffset += 1;
- 		m_iBumpFrame++;
-		if (m_iBumpFrame >= NUM_BUMP_FRAMES) {
-			m_iBumpFrame = 0;
-		}
+		m_riverVOrigin += 0.002f * timeScale;
+		m_riverXOffset += (Real)(MagicOffset * timeScale);
+		m_riverYOffset += (Real)(2 * MagicOffset * timeScale);
+
+		if (m_riverXOffset > 1.0f)
+			m_riverXOffset -= (Int)m_riverXOffset;
+
+		if (m_riverYOffset > 1.0f)
+			m_riverYOffset -= (Int)m_riverYOffset;
+
+		m_fBumpFrame += timeScale;
+		if (m_fBumpFrame >= NUM_BUMP_FRAMES)
+			m_fBumpFrame = 0.0f;
 
 		// for vertex animated water we need to update the vector field
 		if( m_doWaterGrid && m_meshInMotion == TRUE )
 		{
 			const Real PREFERRED_HEIGHT_FUDGE = 1.0f;		///< this is close enough to at rest
-			const Real AT_REST_VELOCITY_FUDGE = 1.0f;		///< when we're close enought to at rest height and velocity we will stop
+			const Real AT_REST_VELOCITY_FUDGE = 1.0f;		///< when we're close enough to at rest height and velocity we will stop
 			const Real WATER_DAMPENING = 0.93f;					///< use with up force of 15.0
 			Int i, j;
 			Int	mx = m_gridCellsX+1;
@@ -1303,9 +1301,6 @@ void WaterRenderObjClass::update( void )
 
 		}
 
-		// mark the last logic frame we processed on
-		lastLogicFrame = currLogicFrame;
-
 	}
 
 }
@@ -1846,7 +1841,7 @@ void WaterRenderObjClass::drawSea(RenderInfoClass & rinfo)
 	m_pDev->SetTextureStageState(1, D3DTSS_ADDRESSU, D3DTADDRESS_CLAMP);
 	m_pDev->SetTextureStageState(1, D3DTSS_ADDRESSV, D3DTADDRESS_CLAMP);
 
-	m_pDev->SetTexture( 0, m_pBumpTexture[m_iBumpFrame]);
+	m_pDev->SetTexture( 0, m_pBumpTexture[(Int)m_fBumpFrame]);
 #ifdef MIPMAP_BUMP_TEXTURE
 	m_pDev->SetTextureStageState( 0, D3DTSS_MIPFILTER, D3DTEXF_POINT );
 	m_pDev->SetTextureStageState( 0, D3DTSS_MINFILTER, D3DTEXF_LINEAR );