Update Repo + New IterateDrawablesInRegion Implementation

Author: IamInnocent3X

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

@@ -556,6 +556,10 @@ class GlobalData : public SubsystemInterface
 	//-allAdvice feature
 	//Bool m_allAdvice;
 
+	Bool m_usePartitionManagerToIterateDrawables;
+	Bool m_usePartitionManagerToIterateDrawablesOnlySelect;
+	Bool m_useEfficientDrawableScheme;
+
 
 	// the trailing '\' is included!
   const AsciiString &getPath_UserData() const { return m_userDataDir; }

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

@@ -640,6 +640,7 @@ class Drawable : public Thing,
 
 	virtual void reactToTransformChange(const Matrix3D* oldMtx, const Coord3D* oldPos, Real oldAngle);
 	void updateHiddenStatus();
+	Bool checkDrawModuleNullptr(DrawModule** dm);
 
 private:
 

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

@@ -157,6 +157,10 @@ class GameClient : public SubsystemInterface,
 	void incrementRenderedObjectCount() { m_renderedObjectCount++; }
 	virtual void notifyTerrainObjectMoved(Object *obj) = 0;
 
+	void informClientNewDrawable(Drawable *draw);
+	void addDrawableToEfficientList(Drawable *draw);
+	inline void clearEfficientDrawablesList() { m_drawablesListMarkedForClear = TRUE; }
+
 
 protected:
 
@@ -215,6 +219,9 @@ class GameClient : public SubsystemInterface,
 	typedef std::list< Drawable* > TextBearingDrawableList;
 	typedef TextBearingDrawableList::iterator TextBearingDrawableListIterator;
 	TextBearingDrawableList m_textBearingDrawableList;	///< the drawables that have registered here during drawablepostdraw
+
+	std::list< Drawable* > m_drawablesList;
+	Bool m_drawablesListMarkedForClear;
 };
 
 //Kris: Try not to use this if possible. In every case I found in the code base, the status was always Drawable::SELECTED.

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

@@ -59,6 +59,9 @@
 #include "Common/Snapshot.h"
 #include "Common/Geometry.h"
 #include "GameClient/Display.h"	// for ShroudLevel
+#include "GameClient/Drawable.h"
+
+class Drawable;
 
 //-----------------------------------------------------------------------------
 //           defines
@@ -1534,6 +1537,10 @@ class PartitionManager : public SubsystemInterface, public Snapshot
 	// If saveToFog is false, then we are writing STORE_PERMENANT_REVEAL
 	void storeFoggedCells(ShroudStatusStoreRestore &outPartitionStore, Bool storeToFog) const;
 	void restoreFoggedCells(const ShroudStatusStoreRestore &inPartitionStore, Bool restoreToFog);
+
+	std::list<Drawable*> getDrawablesInRegion( IRegion2D *region2D );
+	std::list<Drawable*> getDrawablesInRegionEfficient();
+	inline Bool hasNoOffset() const { return m_radiusVec.empty(); }
 };
 
 // -----------------------------------------------------------------------------

GeneralsMD/Code/GameEngine/Source/Common/GlobalData.cpp

@@ -494,6 +494,10 @@ GlobalData* GlobalData::m_theOriginal = NULL;
 
 	{ "PlayStats",									INI::parseInt,				NULL,			offsetof( GlobalData, m_playStats ) },
 
+	{ "UsePartitionManagerToIterateDrawables",	 INI::parseBool, NULL, offsetof(GlobalData, m_usePartitionManagerToIterateDrawables) },
+	{ "UsePartitionManagerToIterateDrawablesOnlySelect",	 INI::parseBool, NULL, offsetof(GlobalData, m_usePartitionManagerToIterateDrawablesOnlySelect) },
+	{ "UseEfficientIterateDrawablesScheme",	 INI::parseBool, NULL, offsetof(GlobalData, m_useEfficientDrawableScheme) },
+
 #if defined(RTS_DEBUG)
 	{ "DisableCameraFade",			INI::parseBool,				NULL,			offsetof( GlobalData, m_disableCameraFade ) },
 	{ "DisableScriptedInputDisabling",			INI::parseBool,		NULL,			offsetof( GlobalData, m_disableScriptedInputDisabling ) },
@@ -1029,6 +1033,10 @@ GlobalData::GlobalData()
 
 	m_keyboardCameraRotateSpeed = 0.1f;
 
+	m_usePartitionManagerToIterateDrawables = FALSE;
+	m_usePartitionManagerToIterateDrawablesOnlySelect = FALSE;
+	m_useEfficientDrawableScheme = FALSE;
+
   // Set user data directory based on registry settings instead of INI parameters. This allows us to
   // localize the leaf name.
   char temp[_MAX_PATH + 1];

GeneralsMD/Code/GameEngine/Source/Common/Thing/Thing.cpp

@@ -45,6 +45,7 @@
 #include "Common/Team.h"
 #include "Lib/trig.h"
 #include "GameLogic/TerrainLogic.h"
+#include "GameClient/GameClient.h"
 
 
 static constexpr const Real InitialThingPosX = 0.0f;
@@ -169,6 +170,8 @@ void Thing::setPositionZ( Real z )
 		setTransformMatrix(&mtx);
 	}
 	DEBUG_ASSERTCRASH(!(_isnan(getPosition()->x) || _isnan(getPosition()->y) || _isnan(getPosition()->z)), ("Drawable/Object position NAN! '%s'", m_template->getName().str() ));
+	if(TheGameClient && TheGlobalData->m_useEfficientDrawableScheme && AsObject(this) && AsObject(this)->getDrawable())
+		TheGameClient->informClientNewDrawable(AsObject(this)->getDrawable());
 }
 
 //=============================================================================
@@ -198,6 +201,8 @@ void Thing::setPosition( const Coord3D *pos )
 		setTransformMatrix(&mtx);
 	}
 	DEBUG_ASSERTCRASH(!(_isnan(getPosition()->x) || _isnan(getPosition()->y) || _isnan(getPosition()->z)), ("Drawable/Object position NAN! '%s'", m_template->getName().str() ));
+	if(TheGameClient && TheGlobalData->m_useEfficientDrawableScheme && AsObject(this) && AsObject(this)->getDrawable())
+		TheGameClient->informClientNewDrawable(AsObject(this)->getDrawable());
 }
 
 //=============================================================================

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

@@ -2653,7 +2653,7 @@ void Drawable::draw()
 		applyPhysicsXform(&transformMtx);
 	}
 
-	for (DrawModule** dm = getDrawModules(); *dm; ++dm)
+	for (DrawModule** dm = getDrawModules(); checkDrawModuleNullptr(dm) && *dm; ++dm)
 	{
 		(*dm)->doDrawModule(&transformMtx);
 	}
@@ -3983,7 +3983,7 @@ DrawModule** Drawable::getDrawModules()
 		}
 		else
 		{
-			for (DrawModule** dm2 = dm; *dm2; ++dm2)
+			for (DrawModule** dm2 = dm; checkDrawModuleNullptr(dm2) && *dm2; ++dm2)
 			{
 				ObjectDrawInterface* di = (*dm2)->getObjectDrawInterface();
 				if (di)
@@ -3998,6 +3998,20 @@ DrawModule** Drawable::getDrawModules()
 	return dm;
 }
 
+Bool Drawable::checkDrawModuleNullptr(DrawModule** dm)
+{
+	if(!TheGlobalData->m_useEfficientDrawableScheme)
+		return TRUE;
+
+	if(dm == nullptr)
+	{
+		//TheGameClient->removeDrawableFromEfficientList(this);
+		//TheGameClient->clearEfficientDrawablesList();
+		return FALSE;
+	}
+	return TRUE;
+}
+
 //-------------------------------------------------------------------------------------------------
 DrawModule const** Drawable::getDrawModules() const
 {

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

@@ -82,6 +82,7 @@
 #include "GameLogic/GameLogic.h"
 #include "GameLogic/GhostObject.h"
 #include "GameLogic/Object.h"
+#include "GameLogic/PartitionManager.h"
 #include "GameLogic/ScriptEngine.h"		// For TheScriptEngine - jkmcd
 
 #define DRAWABLE_HASH_SIZE	8192
@@ -111,6 +112,9 @@ GameClient::GameClient()
 
 	m_nextDrawableID = (DrawableID)1;
 	TheDrawGroupInfo = new DrawGroupInfo;
+
+	m_drawablesList.clear();
+	m_drawablesListMarkedForClear = FALSE;
 }
 
 //std::vector<std::string>	preloadTextureNamesGlobalHack;
@@ -130,6 +134,10 @@ GameClient::~GameClient()
 	// clear any drawable TOC we might have
 	m_drawableTOC.clear();
 
+	m_drawablesList.clear();
+
+	m_drawablesListMarkedForClear = FALSE;
+
 	//DEBUG_LOG(("Preloaded texture files ------------------------------------------"));
 	//for (Int oog=0; oog<preloadTextureNamesGlobalHack2.size(); ++oog)
 	//{
@@ -477,6 +485,9 @@ void GameClient::reset( void )
 	// TheSuperHackers @fix Mauller 13/04/2025 Reset the drawable id so it does not keep growing over the lifetime of the game.
 	m_nextDrawableID = (DrawableID)1;
 
+	m_drawablesList.clear();
+	m_drawablesListMarkedForClear = FALSE;
+
 }
 
 /** -----------------------------------------------------------------------------------------------
@@ -784,21 +795,119 @@ void GameClient::updateHeadless()
  */
 void GameClient::iterateDrawablesInRegion( Region3D *region, GameClientFuncPtr userFunc, void *userData )
 {
-	Drawable *draw, *nextDrawable;
+	if(m_drawablesListMarkedForClear)
+	{
+		m_drawablesList.clear();
+		m_drawablesListMarkedForClear = FALSE;
+	}
+	
+	if(region != NULL && TheGlobalData->m_useEfficientDrawableScheme && !m_drawablesList.empty())
+	{
+		//IamInnocent - Attempted to use an Efficient Implementation of PartitionManager code to use WorldCell for Finding Drawables - 7/10/2025
+		for( std::list< Drawable* >::iterator it = m_drawablesList.begin(); it != m_drawablesList.end();)
+		{
+			Coord3D pos = *(*it)->getPosition();
+			if( pos.x >= region->lo.x && pos.x <= region->hi.x &&
+				pos.y >= region->lo.y && pos.y <= region->hi.y &&
+					pos.z >= region->lo.z && pos.z <= region->hi.z )
+			{
+				(*userFunc)( (*it), userData );
+			}
+			else
+			{
+				it = m_drawablesList.erase(it);
+				continue;
+			}
+			++it;
+		}
 
-	for( draw = m_drawableList; draw; draw=nextDrawable )
+		std::list< Drawable* > newDrawables = ThePartitionManager->getDrawablesInRegionEfficient();
+
+		if(!newDrawables.empty())
+		{
+			for( std::list< Drawable* >::const_iterator it_new = newDrawables.begin(); it_new != newDrawables.end(); ++it_new )
+			{
+				Coord3D pos_new = *(*it_new)->getPosition();
+				if( pos_new.x >= region->lo.x && pos_new.x <= region->hi.x &&
+					pos_new.y >= region->lo.y && pos_new.y <= region->hi.y &&
+						pos_new.z >= region->lo.z && pos_new.z <= region->hi.z )
+				{
+					addDrawableToEfficientList(*it_new);
+					(*userFunc)( (*it_new), userData );
+				}
+			}
+		}
+	}
+	else if(region == NULL || ThePartitionManager->hasNoOffset() || 
+	    ( !TheGlobalData->m_usePartitionManagerToIterateDrawables || TheGlobalData->m_usePartitionManagerToIterateDrawablesOnlySelect ) )
 	{
-		nextDrawable = draw->getNextDrawable();
+		Drawable *draw, *nextDrawable;
 
-		Coord3D pos = *draw->getPosition();
-		if( region == NULL ||
-			  (pos.x >= region->lo.x && pos.x <= region->hi.x &&
-			   pos.y >= region->lo.y && pos.y <= region->hi.y &&
-				 pos.z >= region->lo.z && pos.z <= region->hi.z) )
+		for( draw = m_drawableList; draw; draw=nextDrawable )
 		{
-			(*userFunc)( draw, userData );
+			nextDrawable = draw->getNextDrawable();
+
+			Coord3D pos = *draw->getPosition();
+			if( region == NULL ||
+				(pos.x >= region->lo.x && pos.x <= region->hi.x &&
+				pos.y >= region->lo.y && pos.y <= region->hi.y &&
+					pos.z >= region->lo.z && pos.z <= region->hi.z) )
+			{
+				if(TheGlobalData->m_useEfficientDrawableScheme)
+					addDrawableToEfficientList(draw);
+				(*userFunc)( draw, userData );
+			}
 		}
 	}
+	else
+	{
+		//IamInnocent - Attempted to use PartitionManager code to use WorldCell for Finding Drawables - 6/10/2025
+		std::list< Drawable* > drawables = ThePartitionManager->getDrawablesInRegion( NULL );
+		
+		for( std::list< Drawable* >::iterator it = drawables.begin(); it != drawables.end(); ++it )
+		{
+			Coord3D pos = *(*it)->getPosition();
+			if( pos.x >= region->lo.x && pos.x <= region->hi.x &&
+				pos.y >= region->lo.y && pos.y <= region->hi.y &&
+					pos.z >= region->lo.z && pos.z <= region->hi.z )
+			{
+				if(TheGlobalData->m_useEfficientDrawableScheme)
+					addDrawableToEfficientList(*it);
+				(*userFunc)( (*it), userData );
+			}
+		}
+	}
+}
+
+
+/** -----------------------------------------------------------------------------------------------
+ * Inform the Client to add this Unit to the Efficient Drawable Lisst
+ */
+void GameClient::informClientNewDrawable(Drawable *draw)
+{
+	// sanity
+	if( draw == NULL )
+		return;
+
+	// Efficient drawing scheme is not on
+	// Checked on the Thing.cpp
+	//if(!TheGlobalData->m_useEfficientDrawableScheme)
+	//	return;
+
+	// Only inform New Drawable if the drawables are checked at least once.
+	if(m_drawablesList.empty())
+		return;
+
+	addDrawableToEfficientList(draw);
+}
+
+void GameClient::addDrawableToEfficientList(Drawable *draw)
+{
+	std::list< Drawable* >::iterator it = std::find(m_drawablesList.begin(), m_drawablesList.end(), draw);
+	if (it == m_drawablesList.end())
+	{
+		m_drawablesList.push_back( draw );
+	}
 }
 
 /**Helper function to update fake GLA structures to become visible to certain players.