tweak(drawable): Decouple material opacity of detected stealth models from render update

Scalar value is calculated ahead of rendering.

Author: Caball009

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

@@ -542,8 +542,9 @@ class Drawable : public Thing,
 	void setEffectiveOpacity( Real pulseFactor, Real explicitOpacity = -1.0f );
 
 	// this is for the add'l pass fx which operates completely independently of the stealth opacity effects. Draw() does the fading every frame.
-	Real getSecondMaterialPassOpacity() const { return m_secondMaterialPassOpacity; }		///< get alpha/opacity value used to render add'l  rendering pass.
-	void setSecondMaterialPassOpacity( Real op ) { m_secondMaterialPassOpacity = op; }; ///< set alpha/opacity value used to render add'l  rendering pass.
+	Real getSecondMaterialPassOpacity() const { return m_secondMaterialPassOpacity; }								///< get alpha/opacity value used to render add'l  rendering pass.
+	void setSecondMaterialPassOpacity( Real op ) { m_secondMaterialPassOpacity = op; };							///< set alpha/opacity value used to render add'l  rendering pass.
+	void allowRefillSecondMaterialPassOpacity() { m_secondMaterialPassOpacityAllowRefill = TRUE; }	///< allow the second material opacity to be set to 1.0f
 
 	// both of these assume that you are starting at one extreme 100% or 0% opacity and are trying to go to the other!! -- amit
 	void fadeOut( UnsignedInt frames );		///< fade object out...how gradually this is done is determined by frames
@@ -723,7 +724,9 @@ class Drawable : public Thing,
 	UnsignedInt					m_expirationDate;		///< if nonzero, Drawable should destroy itself at this frame
 	DrawableIconInfo*		m_iconInfo;					///< lazily allocated!
 
-	Real m_secondMaterialPassOpacity;			///< drawable gets rendered again in hardware with an extra material layer
+	Real m_secondMaterialPassOpacity;							///< drawable gets rendered again in hardware with an extra material layer
+	Real m_secondMaterialPassOpacityScalar;				///< multiply opacity by scalar value; useful for non-default render framerates
+	Bool m_secondMaterialPassOpacityAllowRefill;	///< allow the second material opacity to be set to 1.0f
 	// --------- BYTE-SIZED THINGS GO HERE
 	Byte m_selected;						///< drawable is selected or not
 	Bool m_hidden;							///< drawable is "hidden" or not (overrides stealth effects)

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

@@ -87,8 +87,8 @@
 #endif
 
 
-#define VERY_TRANSPARENT_MATERIAL_PASS_OPACITY (0.001f)
-#define MATERIAL_PASS_OPACITY_FADE_SCALAR (0.8f)
+#define MATERIAL_PASS_OPACITY_MIN (0.001f)
+#define MATERIAL_PASS_OPACITY_DEFAULT_FADE_SCALAR (0.8f)
 
 static const char *const TheDrawableIconNames[] =
 {
@@ -433,6 +433,8 @@ Drawable::Drawable( const ThingTemplate *thingTemplate, DrawableStatusBits statu
 	m_hidden = false;
 	m_hiddenByStealth = false;
 	m_secondMaterialPassOpacity = 0.0f;
+	m_secondMaterialPassOpacityScalar = MATERIAL_PASS_OPACITY_DEFAULT_FADE_SCALAR;
+	m_secondMaterialPassOpacityAllowRefill = false;
 	m_drawableFullyObscuredByShroud = false;
 
   m_receivesDynamicLights = TRUE; // a good default... overridden by one of my draw modules if at all
@@ -2607,17 +2609,37 @@ void Drawable::setStealthLook(StealthLookType look)
 //-------------------------------------------------------------------------------------------------
 void Drawable::draw()
 {
-  if ( testTintStatus( TINT_STATUS_FRENZY ) == FALSE )
+  if (testTintStatus(TINT_STATUS_FRENZY) == FALSE)
   {
-    if ( getObject() && getObject()->isEffectivelyDead() )
-		  m_secondMaterialPassOpacity = 0.0f;//dead folks don't stealth anyway
-	  else if ( m_secondMaterialPassOpacity > VERY_TRANSPARENT_MATERIAL_PASS_OPACITY )// keep fading any add'l material unless something has set it to zero
-		  m_secondMaterialPassOpacity *= MATERIAL_PASS_OPACITY_FADE_SCALAR;
-	  else
-		  m_secondMaterialPassOpacity = 0.0f;
+		if (getObject() && getObject()->isEffectivelyDead())
+		{
+			m_secondMaterialPassOpacity = 0.0f;//dead folks don't stealth anyway
+		}
+		else if (!TheFramePacer->isGameHalted())
+		{
+			// TheSuperHackers @tweak The opacity step is now decoupled from the render update.
+			if (m_secondMaterialPassOpacity > MATERIAL_PASS_OPACITY_MIN)
+			{
+				m_secondMaterialPassOpacity *= m_secondMaterialPassOpacityScalar;
+			}
+			else if (m_secondMaterialPassOpacityAllowRefill)
+			{
+				// min opacity = (X ^ (framerate / updatesPerSec)) -> e.g. [ 0.05 = X ^ (100 / 2) ] -> [ X = 0.941845 ] -> [ 0.941845 ^ 50 = 0.05 ]
+				// changes to the updates per second value need to be tested with a single stealth detector, max 30 logic frames and unlimited render frames
+				const Real updatesPerSec = 2.0f;
+				const Real scalar = pow(MATERIAL_PASS_OPACITY_MIN, updatesPerSec / TheFramePacer->getUpdateFps());
+
+				m_secondMaterialPassOpacity = scalar;
+				m_secondMaterialPassOpacityScalar = scalar;
+				m_secondMaterialPassOpacityAllowRefill = FALSE;
+			}
+			else
+			{
+				m_secondMaterialPassOpacity = 0.0f;
+			}
+		}
   }
 
-
 	if (m_hidden || m_hiddenByStealth || getFullyObscuredByShroud())
 		return;	// my, that was easy
 

GeneralsMD/Code/GameEngine/Source/GameLogic/Object/Update/StealthDetectorUpdate.cpp

@@ -306,7 +306,8 @@ UpdateSleepTime StealthDetectorUpdate::update( void )
 			Drawable *theirDraw = them->getDrawable();
 			if ( theirDraw && !them->isKindOf(KINDOF_MINE))
 			{
-				theirDraw->setSecondMaterialPassOpacity( 1.0f );
+				// TheSuperHackers @tweak Don't set opacity here as it should be decoupled from the logic frame rate and not be set for every stealth detector.
+				theirDraw->allowRefillSecondMaterialPassOpacity();
 			}
 
 			if (data->m_IRGridParticleSysTmpl)

GeneralsMD/Code/GameEngine/Source/GameLogic/Object/Update/StealthUpdate.cpp

@@ -431,7 +431,8 @@ void StealthUpdate::hintDetectableWhileUnstealthed()
 		{
 			Drawable *selfDraw = self->getDrawable();
 			if ( selfDraw )
-				selfDraw->setSecondMaterialPassOpacity( 1.0f );
+				// TheSuperHackers @tweak Don't set opacity here as it should be decoupled from the logic frame rate.
+				selfDraw->allowRefillSecondMaterialPassOpacity();
 		}
 	}
 }