Skip to content

[ZH] Use hash maps for Object and Drawable lookups in GameClient, GameLogic like Generals does #676

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xezon merged 2 commits into from
Apr 14, 2025
Merged

[ZH] Use hash maps for Object and Drawable lookups in GameClient, GameLogic like Generals does #676

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d31f742
[ZH] Refactor GameLogic to use a hashmap again for its object lookup …
Mauller Apr 13, 2025
cdcc299
[ZH] Refactor GameClient to use hashmap again for its drawble lookup …
Mauller Apr 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 9 additions & 17 deletions GeneralsMD/Code/GameEngine/Include/GameClient/GameClient.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,8 @@ class SnowManager;

/// Function pointers for use by GameClient callback functions.
typedef void (*GameClientFuncPtr)( Drawable *draw, void *userData );
//typedef std::hash_map<DrawableID, Drawable *, rts::hash<DrawableID>, rts::equal_to<DrawableID> > DrawablePtrHash;
//typedef DrawablePtrHash::iterator DrawablePtrHashIt;

typedef std::vector<Drawable*> DrawablePtrVector;
typedef std::hash_map<DrawableID, Drawable *, rts::hash<DrawableID>, rts::equal_to<DrawableID> > DrawablePtrHash;
typedef DrawablePtrHash::iterator DrawablePtrHashIt;

//-----------------------------------------------------------------------------
/** The Client message dispatcher, this is the last "translator" on the message
Expand Down Expand Up @@ -165,8 +163,7 @@ class GameClient : public SubsystemInterface,
UnsignedInt m_frame; ///< Simulation frame number from server

Drawable *m_drawableList; ///< All of the drawables in the world
// DrawablePtrHash m_drawableHash; ///< Used for DrawableID lookups
DrawablePtrVector m_drawableVector;
DrawablePtrHash m_drawableHash; ///< Used for DrawableID lookups

DrawableID m_nextDrawableID; ///< For allocating drawable id's
DrawableID allocDrawableID( void ); ///< Returns a new unique drawable id
Expand Down Expand Up @@ -241,18 +238,13 @@ inline Drawable* GameClient::findDrawableByID( const DrawableID id )
if( id == INVALID_DRAWABLE_ID )
return NULL;

// DrawablePtrHashIt it = m_drawableHash.find(id);
// if (it == m_drawableHash.end()) {
// // no such drawable
// return NULL;
// }
//
// return (*it).second;

if( (size_t)id < m_drawableVector.size() )
return m_drawableVector[(size_t)id];
DrawablePtrHashIt it = m_drawableHash.find(id);
if (it == m_drawableHash.end()) {
// no such drawable
return NULL;
}

return NULL;
return (*it).second;
}


Expand Down
20 changes: 7 additions & 13 deletions GeneralsMD/Code/GameEngine/Include/GameLogic/GameLogic.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,10 +92,9 @@ enum

/// Function pointers for use by GameLogic callback functions.
typedef void (*GameLogicFuncPtr)( Object *obj, void *userData );
//typedef std::hash_map<ObjectID, Object *, rts::hash<ObjectID>, rts::equal_to<ObjectID> > ObjectPtrHash;
//typedef ObjectPtrHash::const_iterator ObjectPtrIter;
typedef std::hash_map<ObjectID, Object *, rts::hash<ObjectID>, rts::equal_to<ObjectID> > ObjectPtrHash;
typedef ObjectPtrHash::const_iterator ObjectPtrIter;

typedef std::vector<Object*> ObjectPtrVector;

// ------------------------------------------------------------------------------------------------
/**
Expand Down Expand Up @@ -320,8 +319,7 @@ class GameLogic : public SubsystemInterface, public Snapshot
WindowLayout *m_background;

Object* m_objList; ///< All of the objects in the world.
// ObjectPtrHash m_objHash; ///< Used for ObjectID lookups
ObjectPtrVector m_objVector;
ObjectPtrHash m_objHash; ///< Used for ObjectID lookups

// this is a vector, but is maintained as a priority queue.
// never modify it directly; please use the proper access methods.
Expand Down Expand Up @@ -412,15 +410,11 @@ inline Object* GameLogic::findObjectByID( ObjectID id )
if( id == INVALID_ID )
return NULL;

// ObjectPtrHash::iterator it = m_objHash.find(id);
// if (it == m_objHash.end())
// return NULL;
//
// return (*it).second;
if( (size_t)id < m_objVector.size() )
return m_objVector[(size_t)id];
ObjectPtrHash::iterator it = m_objHash.find(id);
if (it == m_objHash.end())
return NULL;

return NULL;
return (*it).second;
}


Expand Down
21 changes: 8 additions & 13 deletions GeneralsMD/Code/GameEngine/Source/GameClient/GameClient.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -450,11 +450,12 @@ void GameClient::init( void )
void GameClient::reset( void )
{
Drawable *draw, *nextDraw;
// m_drawableHash.clear();
// m_drawableHash.resize(DRAWABLE_HASH_SIZE);

m_drawableVector.clear();
m_drawableVector.resize(DRAWABLE_HASH_SIZE, NULL);
m_drawableHash.clear();
#if USING_STLPORT
m_drawableHash.resize(DRAWABLE_HASH_SIZE);
#else
m_drawableHash.reserve(DRAWABLE_HASH_SIZE);
#endif

// need to reset the in game UI to clear drawables before they are destroyed
TheInGameUI->reset();
Expand Down Expand Up @@ -862,12 +863,7 @@ void GameClient::addDrawableToLookupTable(Drawable *draw )
return;

// add to lookup
// m_drawableHash[ draw->getID() ] = draw;
DrawableID newID = draw->getID();
while( newID >= m_drawableVector.size() ) // Fail case is hella rare, so faster to double up on size() call
m_drawableVector.resize(m_drawableVector.size() * 2, NULL);

m_drawableVector[ newID ] = draw;
m_drawableHash[ draw->getID() ] = draw;

} // end addDrawableToLookupTable

Expand All @@ -882,8 +878,7 @@ void GameClient::removeDrawableFromLookupTable( Drawable *draw )
return;

// remove from table
// m_drawableHash.erase( draw->getID() );
m_drawableVector[ draw->getID() ] = NULL;
m_drawableHash.erase( draw->getID() );

} // end removeDrawableFromLookupTable

Expand Down
21 changes: 8 additions & 13 deletions GeneralsMD/Code/GameEngine/Source/GameLogic/System/GameLogic.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -441,11 +441,12 @@ void GameLogic::reset( void )
destroyAllObjectsImmediate();

// set the hash to be rather large. We need to optimize this value later.
// m_objHash.clear();
// m_objHash.resize(OBJ_HASH_SIZE);
m_objVector.clear();
m_objVector.resize(OBJ_HASH_SIZE, NULL);

m_objHash.clear();
#if USING_STLPORT
m_objHash.resize(OBJ_HASH_SIZE);
#else
m_objHash.reserve(OBJ_HASH_SIZE);
#endif
m_gamePaused = FALSE;
m_inputEnabledMemory = TRUE;
m_mouseVisibleMemory = TRUE;
Expand Down Expand Up @@ -3857,12 +3858,7 @@ void GameLogic::addObjectToLookupTable( Object *obj )
return;

// add to lookup
// m_objHash[ obj->getID() ] = obj;
ObjectID newID = obj->getID();
while( newID >= m_objVector.size() ) // Fail case is hella rare, so faster to double up on size() call
m_objVector.resize(m_objVector.size() * 2, NULL);

m_objVector[ newID ] = obj;
m_objHash[ obj->getID() ] = obj;

} // end addObjectToLookupTable

Expand All @@ -3877,8 +3873,7 @@ void GameLogic::removeObjectFromLookupTable( Object *obj )
return;

// remove from lookup table
// m_objHash.erase( obj->getID() );
m_objVector[ obj->getID() ] = NULL;
m_objHash.erase( obj->getID() );

@xezon xezon Apr 13, 2025

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is nice. This actually means that the assert is no longer necessary. Because this will only erase if it exists.

@Mauller Mauller Apr 14, 2025

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, did we want to keep them though for sanity checking while debugging?

@xezon xezon Apr 14, 2025

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes can do.


} // end removeObjectFromLookupTable

Expand Down